Check Cluster Witness Deprecated
Validates the specified witness node’s placement configuration.
Request
URLURL
https://{api_host}/rest/vcenter/vcha/cluster/witness?action=check
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
VchaClusterWitnessCheckRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"placement": {
"folder": "string",
"name": "string"
}
}
}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterWitnessCheckResponseBody of type application/json
CheckResult structure containing errors and warnings.
{
"value": {
"errors": [
{
"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"
}
}
]
}
],
"warnings": [
{
"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"
}
}
]
}
]
}
}
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If the credentials provided for authentincating with the active node’s management vCenter server are invalid. If the specified resource spec is deemed invalid for the clone operation. | 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. | com.vmware.vapi.std.errors.invalid_element_configuration : If the active node is on more than one datastore. | com.vmware.vapi.std.errors.not_allowed_in_current_state : If the clone operation is not allowed in the current state of the system.
403
com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
404
com.vmware.vapi.std.errors.not_found : If the active virtual machine is not managed by the specified vCenter server for the active node.
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 '{"spec":{"placement":{"folder":"string","ha_network":"string","ha_network_type":"STANDARD_PORTGROUP","host":"string","management_network":"string","management_network_type":"STANDARD_PORTGROUP","name":"string","resource_pool":"string","storage":{"datastore":"string"}},"vc_spec":{"active_location":{"hostname":"string","password":"string","port":0,"ssl_thumbprint":"string","username":"string"}}}}' https://{api_host}/rest/vcenter/vcha/cluster/witness?action=check
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/witness?action=check
x-vmw-doc-operation: check
Availability
Added in 6.7.1
