GET /upgradestatusinfo/{uuid}

/upgradestatusinfo/{uuid}

Request

URI

GET

https://api_host/api/upgradestatusinfo/{uuid}

COPY

Path Parameters

string

uuid

Required

UUID of the object to fetch

Query Parameters

string

name

Optional

object name

string

fields

Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean

include_name

Optional

All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

boolean

skip_default

Optional

Default values are not set.

string

join_subresources

Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

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.

Responses

200

Returns UpgradeStatusSummary of type(s) application/json

{
    "_last_modified": "string",
    "enable_patch_rollback": false,
    "enable_rollback": false,
    "end_time": "string",
    "image_ref": "string",
    "name": "string",
    "node_type": "string",
    "obj_cloud_ref": "string",
    "patch_image_ref": "string",
    "start_time": "string",
    "state": {
        "last_changed_time": {
            "secs": 0,
            "usecs": 0
        },
        "reason": "string",
        "rebooted": false,
        "state": "string"
    },
    "tasks_completed": 0,
    "tenant_ref": "string",
    "total_tasks": 0,
    "upgrade_ops": "string",
    "url": "string",
    "uuid": "string",
    "version": "string"
}

string

_last_modified

Optional

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

boolean

enable_patch_rollback

Optional

Check if the patch rollback is possible on this node. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

enable_rollback

Optional

Check if the rollback is possible on this node. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

end_time

Optional

End time of upgrade operations. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

image_ref

Optional

Image uuid for identifying the current base image. It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

name

Optional

Name of the system such as cluster name, se group name and se name. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

node_type

Optional

Type of the system such as controller_cluster, se_group or se. Enum options - NODE_CONTROLLER_CLUSTER, NODE_SE_GROUP, NODE_SE_TYPE. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

obj_cloud_ref

Optional

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

string

patch_image_ref

Optional

Image uuid for identifying the current patch. It is a reference to an object of type Image. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

start_time

Optional

Start time of upgrade operations. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

UpgradeOpsState

state

Optional

state

integer As int32 As int32

tasks_completed

Optional

Upgrade tasks completed. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, 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 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32

total_tasks

Optional

Total upgrade tasks. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

upgrade_ops

Optional

Upgrade operations requested. Enum options - UPGRADE, PATCH, ROLLBACK, ROLLBACKPATCH, SEGROUP_RESUME, EVAL_UPGRADE, EVAL_PATCH, EVAL_ROLLBACK, EVAL_ROLLBACKPATCH, EVAL_SEGROUP_RESUME, EVAL_RESTORE, RESTORE. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

url

Optional

url

string

uuid

Optional

UUID Identifier for the system such as cluster, se group and se. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

version

Optional

Current base image applied to this node. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

401

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Query Parameters

Header Parameters

Response

200 Response Body

Errors

Upgrade Status Summary Operations