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

Get vVol Fault Domain Replication Group

Description

Get information about a replication group that is part of a VMware Virtual Volumes fault domain.

Request

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/srms/{srm_id}/replication-management/vvol/fault-domains/{domain_id}/replication-groups/{replication_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
srm_id Required

ID of a Site Recovery Manager server.


string
domain_id Required

The ID of the vSphere Virtual Volumes (vVols) fault domain that is part of the current pairing.


string
replication_group_id Required

The ID of a VMware Virtual Volumes replication group.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns VvolReplicationGroupInfoDrResponseEntity of type application/json

Information about a replication group within a given fault domain.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"errors": [
		"string"
	],
	"id": "string",
	"name": "string",
	"replication_group_info": {
		"device_group_id": "string",
		"fault_domain_id": "string"
	},
	"vm_infos": [
		{
			"errors": [
				"string"
			],
			"id": "string",
			"inside_vapp": false,
			"name": "string",
			"template": false,
			"vvol_replication_groups": [
				{
					"device_group_id": "string",
					"fault_domain_id": "string"
				}
			],
			"warnings": [
				"string"
			]
		}
	],
	"warnings": [
		"string"
	]
}
_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-SrmGetVvolFaultDomainReplicationGroup -pairingId "MypairingId" -srmId "MysrmId" -domainId "MydomainId" -replicationGroupId "MyreplicationGroupId"

cURL Command

curl https://{api_host}/pairings/{pairing_id}/srms/{srm_id}/replication-management/vvol/fault-domains/{domain_id}/replication-groups/{replication_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: DEPENDS_ON_PROVIDED_PARAMS
    server-down: DEPENDS_ON_PROVIDED_PARAMS


Feedback

Was this page helpful?