This API has a deprecated equivalent from v7.0U1.
Get Operations
Retrieves the current active and disabled operations of a VCHA cluster.
Request
URLURL
https://{api_host}/api/vcenter/vcha/operations
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
VchaOperationsInfo
of type application/json
Info structure containing the current running and disabled operations of a VCHA cluster.
{
"active": [
"string"
],
"disabled": [
"string"
]
}
array of
string
active
Required
Identifiers of the operations that are currently running. These operation strings are one of “com.vmware.vcenter.vcha.cluster.deploy”, “com.vmware.vcenter.vcha.cluster.failover”, “com.vmware.vcenter.vcha.cluster.passive.redeploy”, “com.vmware.vcenter.vcha.cluster.witness.redeploy”, “com.vmware.vcenter.vcha.cluster.mode.set”, and “com.vmware.vcenter.vcha.cluster.undeploy”. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vapi.operation.
array of
string
disabled
Required
Identifiers of the operations that are current disabled. These operation strings are one of “com.vmware.vcenter.vcha.cluster.deploy”, “com.vmware.vcenter.vcha.cluster.failover”, “com.vmware.vcenter.vcha.cluster.passive.redeploy”, “com.vmware.vcenter.vcha.cluster.witness.redeploy”, “com.vmware.vcenter.vcha.cluster.mode.set”, “com.vmware.vcenter.vcha.cluster.undeploy” and “com.vmware.vcenter.vcha.cluster.get”. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vapi.operation. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vapi.operation.
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.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVchaOperations
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vcha/operations
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/operations
x-vmw-doc-operation: get
Availability
Added in 7.0U2
