REST API - list

vcenter namespace management software clusters: list

Returns upgrade related information about all WCP enabled clusters.

Request:

HTTP request

GET https://{server}/api/vcenter/namespace-management/software/clusters

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "cluster""obj-103",
        "cluster_name""obj-103",
        "desired_version""string",
        "available_versions"[
            "string",
            "string"
        ],
        "current_version""string",
        "state""PENDING",
        "last_upgraded_date""2015-01-01T22:13:05.651Z"
    },
    {
        "cluster""obj-103",
        "cluster_name""obj-103",
        "desired_version""string",
        "available_versions"[
            "string",
            "string"
        ],
        "current_version""string",
        "state""PENDING",
        "last_upgraded_date""2015-01-01T22:13:05.651Z"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] List of upgrade summary of all WCP enabled clusters.
-[].cluster string Identifier for the cluster.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.

-[].cluster_name string Name of the cluster.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource.name. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.name.

-[].current_version string Current version of the cluster.

-[].available_versions string[] Set of versions available for upgrade.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user does not have System.Read privilege.