Get Protection Groups

Get Protection Groups

Get a list of all protection groups associated with an individual cloud file system.

Request
URI
GET
https://{orchestrator_fqdn}/api/vcdr/v1alpha/cloud-file-systems/{cloud_file_system_id}/protection-groups
COPY
Path Parameters
string
cloud_file_system_id
Required

Unique identifier of an individual cloud file system. Use the cloud file system ID of the cloud file system from where you want to get a list of all protected VMs.

Query Parameters
integer
limit
Optional

The maximum number of results to return with the call. The maximum is 500, and the default is 50 results.

ProtectionGroupsFilterSpec
filter_spec
Optional

Used to filter the results.

string
cursor
Optional

An opaque string previously returned by this API that can be passed to this API in order to get the next set of results. If this property is not passed, enumeration of starts from the beginning.

Authentication
This operation uses the following authentication methods.
Responses
200

OK. The request succeeded.

Returns GetProtectionGroupsResponse of type(s) application/json 
{
    "cursor": "string",
    "protection_groups": [
        {
            "id": "string",
            "name": "string"
        }
    ]
}
string
cursor
Optional

An opaque string that can be passed back to this API in order to get the next set of results. If this poperty is not present, no more results are available.

array of ProtectionGroupSummary
protection_groups
Optional

An array of summary information concerning protection groups.


400

Bad request. The server could not understand the request.

Operation doesn't return any data structure

401

Unauthorized. The client has not authenticated.

Operation doesn't return any data structure

403

Forbidden. The client is not authorized.

Operation doesn't return any data structure

404

Not found. The server cannot find the specified resource.

Operation doesn't return any data structure

500

VMware Cloud DR-specific error.
An error unique to VMware Cloud DR was encountered while attempting to satisfy the request. See the returned object for details on the error.

Returns Error of type(s) application/json 
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ]
        }
    ]
}
array of LocalizableMessage
messages
Optional

A stack or error messages. The first element (top of the stack) is the broadest description of the failure.


On This Page
Protection Group Operations
GET
Get Protection Group Details
GET
Get Protection Groups