Get Cluster Deprecated
Retrieves the status of a VCHA cluster.
Request
URLURL
https://{api_host}/rest/vcenter/vcha/cluster?action=get
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"
Request Body
Request Body
VchaClusterGetRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"partial": false,
"vc_spec": {
"active_location": {
"hostname": "string",
"password": "string",
"port": 0,
"ssl_thumbprint": "string",
"username": "string"
}
}
}
boolean
partial
Optional
If true, then return only the information that does not require connecting to the Active vCenter Server. If false or unset, then return all the information. If unset, then return all the information.
vc_spec
Optional
Contains active node’s management vCenter server credentials. If unset, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterGetResponseBody of type application/json
Info structure containing the VCHA configuration and health information.
{
"value": {
"auto_failover_allowed": false,
"config_state": "CONFIGURED",
"health_exception": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
}
],
"health_state": "HEALTHY",
"health_warnings": [
{
"error": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"recommendation": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
}
}
],
"manual_failover_allowed": false,
"mode": "ENABLED",
"node1": {
"failover_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"ha_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"runtime": {
"placement": {
"bios_uuid": "string",
"cluster": "string",
"cluster_name": "string",
"datacenter": "string",
"datacenter_name": "string",
"ha_network": "string",
"ha_network_name": "string",
"ha_network_type": "STANDARD_PORTGROUP",
"host": "string",
"host_name": "string",
"management_network": "string",
"management_network_name": "string",
"management_network_type": "STANDARD_PORTGROUP",
"management_vcenter_name": "string",
"management_vcenter_server_guid": "string",
"storage": {
"datastore": "string",
"datastore_name": "string"
},
"vm_name": "string"
},
"role": "ACTIVE",
"state": "UP"
}
},
"node2": {
"failover_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"ha_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"runtime": {
"placement": {
"bios_uuid": "string",
"cluster": "string",
"cluster_name": "string",
"datacenter": "string",
"datacenter_name": "string",
"ha_network": "string",
"ha_network_name": "string",
"ha_network_type": "STANDARD_PORTGROUP",
"host": "string",
"host_name": "string",
"management_network": "string",
"management_network_name": "string",
"management_network_type": "STANDARD_PORTGROUP",
"management_vcenter_name": "string",
"management_vcenter_server_guid": "string",
"storage": {
"datastore": "string",
"datastore_name": "string"
},
"vm_name": "string"
},
"role": "ACTIVE",
"state": "UP"
}
},
"witness": {
"ha_ip": {
"gateway_ip": "string",
"ip_family": "IPV4",
"ipv4": {
"address": "string",
"prefix": 0,
"subnet_mask": "string"
},
"ipv6": {
"address": "string",
"prefix": 0
}
},
"runtime": {
"placement": {
"bios_uuid": "string",
"cluster": "string",
"cluster_name": "string",
"datacenter": "string",
"datacenter_name": "string",
"ha_network": "string",
"ha_network_name": "string",
"ha_network_type": "STANDARD_PORTGROUP",
"host": "string",
"host_name": "string",
"management_network": "string",
"management_network_name": "string",
"management_network_type": "STANDARD_PORTGROUP",
"management_vcenter_name": "string",
"management_vcenter_server_guid": "string",
"storage": {
"datastore": "string",
"datastore_name": "string"
},
"vm_name": "string"
},
"role": "ACTIVE",
"state": "UP"
}
}
}
}
value
Optional
Info structure containing the VCHA configuration and health information.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If the credentials provided for authenticating with the active node’s management vCenter server are invalid. | com.vmware.vapi.std.errors.unverified_peer : If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of Error will be a structure that contains all the fields defined in CertificateInfo.
403
com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. - If partial is false or unset, then the operation execution requires the Global.VCServer privilege. - If partial is true, then the operation execution requires the System.Read privilege.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"partial":false,"vc_spec":{"active_location":{"hostname":"string","password":"string","port":0,"ssl_thumbprint":"string","username":"string"}}}' https://{api_host}/rest/vcenter/vcha/cluster?action=get
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/vcenter/vcha/cluster?action=get
x-vmw-doc-operation: get
Availability
Added in 6.7.1
