[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api

Get Datastore Group

Description

A group of replicated datastores.

A datastore group represents a minimal set of datastores that must be protected and recovered together.
The rules for combining datastores are:

  • Datastores are backed by storage devices from the same consistency group.
  • Virtual machine spans multiple datastores.
  • Two virtual machines on two different datastores share an RDM device.

For a non-Array-Based Replication protection group, this will return an empty response.

Request

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/protection-management/groups/{group_id}/datastore-groups/{datastore_group_id}
Copy

Path Parameters

Path Parameters

string
pairing_id Required

The ID of a pairing between this Site Recovery Manager server and remote one.


string
group_id Required

The ID of a protection group defined within current pairing.


string
datastore_group_id Required

The ID of a datastore group.


Query Parameters

Query Parameters

boolean
include_vms_info Optional

If you want VMs info, this will lead to slower and bigger API response.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns DatastoreGroupInfoDrResponseEntity of type application/json

Information of a datastore group related to an Array-Based Replication protection group.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"array_pair": "string",
	"datastores": [
		{
			"capacity_details": {
				"total_capacity": 0,
				"used_space": 0
			},
			"conflict_protection_group": "string",
			"conflict_protection_group_name": "string",
			"id": "string",
			"issue_type": "NONE",
			"name": "string"
		}
	],
	"id": "string",
	"potential_vm_to_add_infos": [
		{
			"datastores": [
				"string"
			],
			"id": "string",
			"inside_vapp": false,
			"name": "string",
			"protection_issues": [
				{
					"datastore": "string",
					"datastore_name": "string",
					"device_id": 0,
					"disk_key": 0,
					"type": "UNKNOWN"
				}
			],
			"protection_status": "PROTECTED",
			"template": false
		}
	],
	"protection_groups": [
		"string"
	],
	"rdm_keys": [
		{
			"id": "string",
			"issue_type": "NONE",
			"name": "string"
		}
	],
	"status": "UNASSIGNED",
	"vm_infos": [
		{
			"datastores": [
				"string"
			],
			"id": "string",
			"inside_vapp": false,
			"name": "string",
			"protection_issues": [
				{
					"datastore": "string",
					"datastore_name": "string",
					"device_id": 0,
					"disk_key": 0,
					"type": "UNKNOWN"
				}
			],
			"protection_status": "PROTECTED",
			"template": false
		}
	]
}
_meta Optional

Response meta data. Contains data about the response payload data.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-SrmGetDatastoreGroup -pairingId "MypairingId" -groupId "MygroupId" -datastoreGroupId "MydatastoreGroupId" -includeVmsInfo $true

cURL Command

curl https://{api_host}/pairings/{pairing_id}/protection-management/groups/{group_id}/datastore-groups/{datastore_group_id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
    permissions:
        - System.View
        - System.Read
x-dr-remote-site-connectivity-contract:
    not-authenticated: FULL_DATA
    server-down: FULL_DATA


Feedback

Was this page helpful?