GET Upgrades Version

GET Upgrades Version

Gets the cluster-wide status of the upgrade.

Request
URI
GET
https://{api_host}/api/v2/upgrades/{version}
COPY
Path Parameters
string
version
Required

The Operations for Logs version of the upgrade


Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved the upgrade status of the cluster.

Returns upgrades.version.get.response of type(s) application/json
{
    "status": {
        "version": "4.0.0-1234567",
        "pakFileName": "VMware-vRealize-Log-Insight-4.0.0-1234567.pak",
        "nodeStatuses": [
            {
                "status": "Upgrading",
                "timestamp": 1496145083890,
                "timestampString": "2017-05-30 15:51:23.890 GMT+04:00",
                "token": "27bcbafc-b99d-4609-9fab-4f3ad937fe5e"
            }
        ],
        "pakFileUrl": "http://vmware.com/downloads/VMware-vRealize-Log-Insight-4.0.0.pak",
        "eulaAccepted": false,
        "masterToken": "27bcbafc-b99d-4609-9fab-4f3ad937fe5e",
        "clusterStatus": "Upgrading",
        "started": "1496145083067",
        "finished": "0",
        "startedString": "2017-05-30 15:51:23.067 GMT+04:00",
        "finishedString": ""
    }
}

401
Operation doesn't return any data structure

440
Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/upgrades/{version}