This API has a deprecated equivalent from v7.0U1.
Get Cluster Deployment Type
Retrieves the deployment type of a VCHA cluster.
Request
URLURL
https://{api_host}/api/vcenter/vcha/cluster/deployment-type
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterDeploymentTypeInfo of type application/json
Info structure containing the deployment type information of the the VCHA cluster.
{
"deployment_type": "NONE"
}
deployment_type
Required
The DeploymentType.Type enumerated type defines the possible deployment types for a VCHA Cluster.
NONE : VCHA Cluster is not configured.
AUTO : VCHA Cluster was deployed automatically.
MANUAL : VCHA Cluster was deployed manually.
Possible values are: NONE , AUTO , MANUAL
Errors
403
com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
Code Samples
Code Samples
PowerCLI Client SDK Example
Invoke-GetVchaClusterDeploymentType
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vcha/cluster/deployment-type
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vcha/cluster/deployment-type
x-vmw-doc-operation: get
Availability
Added in 7.0U2
