Snapservice. Sites. Clusters List

Snapservice. Sites. Clusters List

List the clusters for the specified site.

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/sites/{site}/clusters
COPY
Path Parameters
string
site
Required

Identifier of the site.

The parameter must be an identifier for the resource type: com.vmware.snapservice.site.

Query Parameters
string of array
clusters
Optional

Identifiers of clusters that can match the filter.

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.

string of array
names
Optional

Names of clusters that can match the filter.

This property was added in vSphere API 9.0.0.0.

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

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the clusters matching the Snapservice.Sites.Clusters.FilterSpec.

Returns Snapservice.Sites.Clusters.ListResult of type(s) application/json 
"Snapservice.Sites.Clusters.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"

404

If there is no site associated with site in the system.

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"Vapi.Std.Errors.NotFound 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/sites/{site}/clusters
On This Page
Snapservice.sites.clusters Operations
GET
Snapservice. Sites. Clusters List