Get Protection Group Batch Details

Get Protection Group Batch Details

Get details for one or more requested protection groups.

Request
URI
POST
https://{api_host}/api/vcdr/v1/cloud-file-systems/{cloud_file_system_id}/protection-groups-batch
COPY
Path Parameters
string
cloud_file_system_id
Required

The cloud file system containing the protection groups of interest.


Request Body
{
    "protection_groups": [
        "string"
    ]
}
array of string
protection_groups
Optional

The IDs of the protection groups of interest. All results are returned in a single request, so the number of provided protection groups should be bounded.

Authentication
This operation uses the following authentication methods.
Responses
200

OK. The request succeeded.

Returns GetProtectionGroupBatchDetailsResponse of type(s) application/json
{
    "protection_group_details": [
        {
            "id": "string",
            "name": "string",
            "health": "string",
            "members_specs": [
                {
                    "vcenter_id": "string",
                    "vcenter_vm_name_patterns": [
                        "string"
                    ],
                    "vcenter_tags": [
                        {
                            "category_name": "string",
                            "tag_name": "string"
                        }
                    ],
                    "vcenter_folder_paths": [
                        "string"
                    ]
                }
            ],
            "schedule_specs": [
                {
                    "name": "string",
                    "schedule_spec": {
                        "minutes": 0,
                        "minutes_interval": 0,
                        "hours": 0,
                        "hours_interval": 0,
                        "day_of_month": 0,
                        "day_of_month_interval": 0,
                        "month": 0,
                        "month_interval": 0,
                        "day_of_week": 0,
                        "day_of_week_interval": 0
                    },
                    "retention_min": 0
                }
            ],
            "protected_site_id": "string",
            "snapshot_schedule_active": false,
            "snapshot_frequency_type": "string",
            "snapshot_quiescing_enabled": false,
            "snapshot_timestamp": 0,
            "size_gib": "number",
            "snapshot_count": 0
        }
    ]
}
array of object
protection_group_details
Optional

The array of protection group details.


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 Live Cyber Recovery-specific error.
An error unique to VMware Live Cyber Recovery was encountered while attempting to satisfy the request. See the returned object for details on the error.

Returns Error of type(s) application/json
"Error Object"
array of object
messages
Optional

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


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcdr/v1/cloud-file-systems/{cloud_file_system_id}/protection-groups-batch