REST API - get
  1. Operations
  2. vcenter
  3. vcha
  4. cluster
  5. deployment type

vcenter vcha cluster deployment type: get

Retrieves the deployment type of a VCHA cluster. This operation was added in vSphere API 6.7.1.

Request:

HTTP request

GET https://{server}/rest/vcenter/vcha/cluster/deployment-type
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "deployment_type" : "NONE"
    }
}

Response Type:

Name Type Description
bold = required
value info Info structure containing the deployment type information of the the VCHA cluster.
value.deployment_type string Identifies the deployment type of the VCHA cluster. This attribute was added in vSphere API 6.7.1.

Defines the possible deployment types for a VCHA Cluster. This enumeration was added in vSphere API 6.7.1. Value is one of:
NONE: VCHA Cluster is not configured. This constant was added in vSphere API 6.7.1.
AUTO: VCHA Cluster was deployed automatically. This constant was added in vSphere API 6.7.1.
MANUAL: VCHA Cluster was deployed manually. This constant was added in vSphere API 6.7.1.

Errors:

HTTP Status Code Type Description
403 unauthorized If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
500 error If any other error occurs.