Snapservice. Cluster Pairs List

Snapservice. Cluster Pairs List

List the cluster pairs.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VsanDP.Replication.com.vmware.vsan.snapshotservice.Site.View.
Request
URI
GET
https://{host}/api/snapservice/cluster-pairs
COPY
Query Parameters
string of array
cluster_pairs
Optional

Identifiers of clusters pairs that can match the filter.

This property was added in vSphere API 9.0.0.0.

If missing or null or empty, cluster pairs with any identifier match the filter.

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

string of array
local_clusters
Optional

Identifier of the local clusters that can match the filter. Only cluster pairs with the specified local cluster would be returned.

This property was added in vSphere API 9.0.0.0.

If missing or null or empty, clusters with any identifier match the filter.

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

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the cluster pairs matching the Snapservice.ClusterPairs.FilterSpec.

Returns Snapservice.ClusterPairs.ListResult of type(s) application/json 
"Snapservice.ClusterPairs.ListResult Object"

400

If validation of the filter fails.

Returns Vapi.Std.Errors.InvalidArgument of type(s) application/json 
"Vapi.Std.Errors.InvalidArgument Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

403

If the caller is not authorized to perform the operation.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json 
"Vapi.Std.Errors.Unauthorized Object"

500

If there is unknown internal error.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/snapservice/cluster-pairs
On This Page
Snapservice.cluster Pairs Operations
GET
Snapservice. Cluster Pairs List
GET
Snapservice. Cluster Pairs Get
POST
Snapservice. Cluster Pairs Create Precheck
POST
Snapservice. Cluster Pairs Create$ Task
DELETE
Snapservice. Cluster Pairs Delete$ Task
POST
Snapservice. Cluster Pairs Create Precheck$ Task