Snapservice. Sites Get
Returns information about a 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}
COPY
Path Parameters
string
site
Required
Site identifier.
The parameter must be an identifier for the resource type: com.vmware.snapservice.site.
Responses
200
Information about the specified site.
Returns
Snapservice.Sites.Info
of type(s)
application/json
"Snapservice.Sites.Info Object"
400
Vapi.Std.Errors.InvalidArgument If validation of the site fails.
Vapi.Std.Errors.Unsupported If the API is not supported.
Returns
Vapi.Std.Errors.Error
of type(s)
application/json
"Vapi.Std.Errors.Error 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 the site is not found.
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}