Vcenter Vcha Operations get

Vcenter Vcha Operations get

Retrieves the current active and disabled operations of a VCHA cluster.

This operation was added in vSphere API 6.7.1.

Request
URI
GET
https://{api_host}/api/vcenter/vcha/operations
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Info structure containing the current running and disabled operations of a VCHA cluster.

Returns Vcenter Vcha Operations Info of type(s) application/json 
{
    "disabled": [
        "string"
    ],
    "active": [
        "string"
    ]
}
array of string
disabled
Required

Identifiers of the operations that are current disabled. These operation strings are one of Vcenter Vcha Operations.CLUSTER_DEPLOY_OP, Vcenter Vcha Operations.CLUSTER_FAILOVER_OP, Vcenter Vcha Operations.PASSIVE_REDEPLOY_OP, Vcenter Vcha Operations.WITNESS_REDEPLOY_OP, Vcenter Vcha Operations.MODE_SET_OP, Vcenter Vcha Operations.CLUSTER_UNDEPLOY_OP and Vcenter Vcha Operations.CLUSTER_GET_OP.

This property was added in vSphere API 6.7.1.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vapi.operation. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vapi.operation.

array of string
active
Required

Identifiers of the operations that are currently running. These operation strings are one of Vcenter Vcha Operations.CLUSTER_DEPLOY_OP, Vcenter Vcha Operations.CLUSTER_FAILOVER_OP, Vcenter Vcha Operations.PASSIVE_REDEPLOY_OP, Vcenter Vcha Operations.WITNESS_REDEPLOY_OP, Vcenter Vcha Operations.MODE_SET_OP, and Vcenter Vcha Operations.CLUSTER_UNDEPLOY_OP.

This property was added in vSphere API 6.7.1.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vapi.operation. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vapi.operation.


403

If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

500

If any other error occurs.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

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.

object
data
Optional

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.

string
error_type
Required

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.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/vcha/operations
On This Page
Vcenter Operations
GET
Vcenter Vcha Operations get