PATCH /statediffoperation/{uuid}

PATCH /statediffoperation/{uuid}

/statediffoperation/{uuid}

Request
URI
PATCH
https://{api_host}/api/statediffoperation/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

StatediffOperation object creation

StatediffOperation of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "events": [
        {
            "duration": 0,
            "end_time": "string",
            "message": "string",
            "start_time": "string",
            "status": "string",
            "task_name": "string"
        }
    ],
    "name": "string",
    "node_uuid": "string",
    "operation": "string",
    "phase": "string",
    "status": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns StatediffOperation of type(s) application/json 
"StatediffOperation Object"
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

array of object
events
Optional

Info for each Statediff event. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
name
Optional

Name of Statediff operation. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
node_uuid
Optional

Uuid of node for Statediff operation entry. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
operation
Optional

Type of Statediff operation. Enum options - FB_UPGRADE, FB_ROLLBACK, FB_PATCH, FB_ROLLBACK_PATCH. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
phase
Optional

Phase of Statediff operation. Enum options - FB_PRE_SNAPSHOT, FB_POST_SNAPSHOT. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
status
Optional

Status of Statediff operation. Enum options - FB_INIT, FB_IN_PROGRESS, FB_COMPLETED, FB_FAILED, FB_COMPLETED_WITH_ERRORS. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

unique identifier for Statediff entry. Field introduced in 21.1.3. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Statediff Operation Operations
GET
GET /statediffoperation
POST
POST /statediffoperation
GET
GET /statediffoperation/{uuid}
PUT
PUT /statediffoperation/{uuid}
PATCH
PATCH /statediffoperation/{uuid}
DELETE
DELETE /statediffoperation/{uuid}