Vcenter Vcha Cluster get
Retrieves the status of a VCHA cluster.
This operation was added in vSphere API 6.7.1.
Request body for invoking operation: get
{
"vc_spec": {
"active_location": {
"hostname": "string",
"port": 0,
"ssl_thumbprint": "string",
"ssl_certificate": "string",
"username": "string",
"password": "string"
}
},
"partial": false
}The Vcenter Vcha CredentialsSpec schema contains information to connect to the vCenter server managing the VCHA nodes.
This schema was added in vSphere API 6.7.1.
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 missing or null, then return all the information.
Info structure containing the VCHA configuration and health information.
"Vcenter Vcha Cluster Info Object"Configuration state of the VCHA cluster.
The active node's management vCenter server credentials are not required to populate this property.
For more information see: Vcenter Vcha Cluster ConfigState.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable.
Node configuration information for the VCHA cluster.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable.
Node configuration information for the VCHA cluster.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable or the node is not cloned yet.
Node configuration information for the VCHA cluster.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable or the node is not cloned yet.
Operational mode of the VCHA Cluster.
For more information see: Vcenter Vcha Cluster ClusterMode.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable or the node is not cloned yet.
Last known state of the VCHA Cluster.
For more information see: Vcenter Vcha Cluster ClusterState.
This property was added in vSphere API 6.7.1.
If missing or null, then the information is unavailable or the node is not cloned yet.
Health warning messages if the health information is unavailable.
This property was added in vSphere API 6.7.1.
If missing or null, then the cluster is in a healthy state.
A collection of messages describing the reason for a non-healthy Cluster.
This property was added in vSphere API 6.7.1.
If missing or null, then the cluster is in a healthy state.
Specifies if manual failover is allowed.
This property was added in vSphere API 6.7.1.
If missing or null, then the cluster state healthy and manual failover allowance in accordance with the cluster mode.
Specifies if automatic failover is allowed.
This property was added in vSphere API 6.7.1.
If missing or null, then the cluster state healthy and automatic failover allowance in accordance with the cluster mode.
Vapi Std Errors InvalidArgument If the credentials provided for authenticating with the active node's management vCenter server are invalid.
Vapi Std Errors UnverifiedPeer If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Vapi Std Errors Error will be a schema that contains all the properties defined in Vcenter Vcha CertificateInfo.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
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.
"Vapi Std Errors Unauthorized Object"If any other error occurs.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/vcha/cluster?action=get