DescribeDiskReplicaGroups -

Queries the details of one or more replication pair-consistent groups in a region.

Usage notes

To perform a paged query, specify MaxResults and NextToken.

During a paged query, when you call the DescribeDiskReplicaGroups operation to retrieve the first page of results, set MaxResults to specify the maximum number of entries to return in the call. The return value of NextToken is a pagination token, which can be used in the next call to retrieve a new page of results. When you call the DescribeDiskReplicaGroups operation to retrieve a new page of results, set NextToken to the NextToken value returned in the previous call and set MaxResults to specify the maximum number of entries to return in this call.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDiskReplicaGroups	The operation that you want to perform. Set the value to DescribeDiskReplicaGroups.
RegionId	String	Yes	cn-beijing	The region ID of the replication pair-consistent group.
MaxResults	Long	No	10	The maximum number of entries per page. Valid values: 1 to 500. Default value: 10.
NextToken	String	No	AAAAAdDWBF2****	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. When NextToken is specified, the PageSize and PageNumber request parameters do not take effect and the TotalCount response parameter is invalid.
GroupIds	String	No	AAAAAdDWBF2****	The IDs of replication pair-consistent groups. You can specify the IDs of up to 100 replication pair-consistent groups. Separate the IDs with commas (,). This parameter is empty by default, which indicates that all replication pair-consistent groups in the specified region are queried.
Site	String	No	production	The type of the site from which the information of replication pair-consistent groups is retrieved. This parameter is used for scenarios where data is replicated across zones in replication pairs. If this parameter is not specified, information such as the status of replication pair-consistent groups at the primary site is queried and returned. If this parameter is specified, information such as the status of replication pair-consistent groups at the site specified by this parameter is queried and returned. Valid values: production: primary site backup: secondary site
PageNumber	Integer	No	5	The page number.
PageSize	Integer	No	10	The number of entries per page. Valid values: 1 to 100.
ResourceGroupId	String	No	rg-aekz*****	The ID of the resource group to which the replication pair-consistent group belongs.
Tag.N.Key	String	No	tag-key	The key of tag N of the replication pair-consistent group.
Tag.N.Value	String	No	tag-value	The value of tag N of the replication pair-consistent group.

Response parameters


Parameter	Type	Example	Description
RequestId	String	AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****	The request ID.
NextToken	String	AAAAAdDWBF2****	A pagination token. It can be used in the next request to retrieve a new page of results.
ReplicaGroups	Array of ReplicaGroup		The information about the replication pair-consistent groups.
ReplicaGroupId	String	pg-myreplica****	The ID of the replication pair-consistent group.
SourceRegionId	String	cn-beijing	The region ID of the primary site.
SourceZoneId	String	cn-beijing-f	The zone ID of the primary site.
DestinationRegionId	String	cn-shanghai	The region ID of the secondary site.
DestinationZoneId	String	cn-shanghai-e	The zone ID of the secondary site.
GroupName	String	myreplicagrouptest	The name of the replication pair-consistent group.
Description	String	This is description.	The description of the replication pair-consistent group.
Status	String	created	The state of the replication pair-consistent group. Valid values: invalid: The replication pair-consistent group is invalid, which indicates that abnormal replication pairs are present in the replication pair-consistent group. creating: The replication pair-consistent group is being created. created: The replication pair-consistent group is created. create_failed: The replication pair-consistent group cannot be created. manual_syncing: Data is being manually synchronized between the disks in the replication pair-consistent group. The first time data is being manually synchronized between the disks in a replication pair-consistent group, the replication pair-consistent group is in this state. syncing: Data is being synchronized between the disks in the replication pair-consistent group. When data is being asynchronously replicated from the primary disks to the secondary disks not for the first time, the replication pair-consistent group is in this state. normal: The replication pair-consistent group works as expected. When the system finishes replicating data from the primary disks to the secondary disks within the current replication cycle, the replication pair-consistent group enters this state. stopping: The replication pair-consistent group is being stopped. stopped: The replication pair-consistent group is stopped. stop_failed: The replication pair-consistent group cannot be stopped. failovering: A failover is being performed. failovered: A failover is performed. failover_failed: A failover cannot be performed. reprotecting: A reverse replication is being performed. reprotect_failed: A reverse replication cannot be performed. deleting: The replication pair-consistent group is being deleted. delete_failed: The replication pair-consistent group cannot be deleted. deleted: The replication pair-consistent group is deleted.
RPO	Long	180	The recovery point objective (RPO) of the replication pair-consistent group. Unit: seconds.
LastRecoverPoint	Long	1637835114	The time when data was last replicated from the primary disks to the secondary disks in the replication pair-consistent group. The value of this parameter is a timestamp. Unit: seconds.
Site	String	production	The type of the site from which the information of the replication pair and replication pair-consistent group is obtained. Valid values: production: primary site backup: secondary site
PairIds	Array of String	pair-cn-dsa**,pair-cn-asd**	The IDs of the replications pairs that belong to the replication pair-consistent group.
PairNumber	Long	2	The number of replications pairs that belong to the replication pair-consistent group.
PrimaryRegion	String	cn-beijing	The initial source region (primary region) of the replication pair-consistent group.
StandbyRegion	String	cn-shanghai	The initial destination region (secondary region) of the replication pair-consistent group.
PrimaryZone	String	cn-beijing-h	The initial source zone (primary zone) of the replication pair-consistent group.
StandbyZone	String	cn-shanghai-e	The initial destination zone (secondary zone) of the replication pair-consistent group.
Bandwidth	Long	0	The bandwidth value. Unit: Mbit/s. This parameter is not publicly available and has a system-preset value.
ResourceGroupId	String	rg-aek2a*******	The ID of the resource group to which the replication pair-consistent group belongs.
Tags	Array of Tag		The tags of the replication pair-consistent group.
TagKey	String	testKey	The tag key of the replication pair-consistent group.
TagValue	String	testValue	The tag value of the replication pair-consistent group.
PageNumber	Integer	1	The page number.
PageSize	Integer	10	The number of entries per page.
TotalCount	Long	60	The total number of entries returned.

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=DescribeDiskReplicaGroups
&RegionId=cn-beijing
&MaxResults=10
&NextToken=AAAAAdDWBF2****
&GroupIds=AAAAAdDWBF2****
&Site=production
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDiskReplicaGroupsResponse>
    <RequestId>AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****</RequestId>
    <NextToken>AAAAAdDWBF2****</NextToken>
    <ReplicaGroups>
        <ReplicaGroupId>pg-myreplica****</ReplicaGroupId>
        <SourceRegionId>cn-beijing</SourceRegionId>
        <SourceZoneId>cn-beijing-f</SourceZoneId>
        <DestinationRegionId>cn-shanghai</DestinationRegionId>
        <DestinationZoneId>cn-shanghai-e</DestinationZoneId>
        <GroupName>myreplicagrouptest</GroupName>
        <Description>This is description.</Description>
        <Status>created</Status>
        <RPO>180</RPO>
        <LastRecoverPoint>1637835114</LastRecoverPoint>
        <Site>production</Site>
        <PairIds>pair-cn-dsa****,pair-cn-asd****</PairIds>
        <PairNumber>2</PairNumber>
    </ReplicaGroups>
</DescribeDiskReplicaGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****",
  "NextToken" : "AAAAAdDWBF2****",
  "ReplicaGroups" : [ {
    "ReplicaGroupId" : "pg-myreplica****",
    "SourceRegionId" : "cn-beijing",
    "SourceZoneId" : "cn-beijing-f",
    "DestinationRegionId" : "cn-shanghai",
    "DestinationZoneId" : "cn-shanghai-e",
    "GroupName" : "myreplicagrouptest",
    "Description" : "This is description.",
    "Status" : "created",
    "RPO" : 180,
    "LastRecoverPoint" : 1637835114,
    "Site" : "production",
    "PairIds" : [ "pair-cn-dsa****,pair-cn-asd****" ],
    "PairNumber" : 2
  } ]
}

Error codes


HTTP status code	Error code	Error message	Description
403	OperationDenied	The operation is not allowed.	This operation cannot be performed.
403	OperationDenied.InvalidStatus	The operation is not allowed in current status.	This operation cannot be performed on the replication pair-consistent group in the current state.
403	Forbidden	User is not authorized to operate.	You do not have the permissions to manage the resource. Check the permissions of your account or contact your Alibaba Cloud account administrator.
403	Forbidden.Action	User is not authorized to operate this action.	You have no access to this operation. Check the permissions of your account or contact your Alibaba Cloud account administrator.
404	NoSuchResource	The specified resource does not exist.	The specified resource is not found.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error occurred.
504	RequestTimeout	The request is timeout, please try again later.	The request timed out. Try again later.

For a list of error codes, see Service error codes.