DescribeDiskReplicaGroups - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries the details of replication pair-consistent groups in a specific region.

Operation description

Usage notes

To perform a paged query, specify the MaxResults and NextToken parameters.

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ebs:DescribeDiskReplicaGroups	list	DiskReplicaGroup `acs:ebs:{#regionId}:{#accountId}:diskreplicagroup/` *DiskReplicaGroup `acs:ebs:{#regionId}:{#accountId}:diskreplicagroup/{#ReplicaGroupId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region to which the replication pair-consistent group belongs.	cn-beijing
MaxResults	long	No	The maximum number of entries per page. You can use this parameter together with NextToken. Valid values: 1 to 500. Default value: 10.	10
NextToken	string	No	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. If you specify NextToken, the PageSize and PageNumber request parameters do not take effect, and the TotalCount response parameter is invalid.	AAAAAdDWBF2****
GroupIds	string	No	The IDs of the replication pair-consistent groups. You can specify the IDs of one or more 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. You can specify up to the IDs of 100 replication pair-consistent groups.	AAAAAdDWBF2****
Site	string	No	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. Otherwise, information such as the state of replication pairs at the site specified by the Site parameter is queried and returned. Valid values: production: primary site backup: secondary site	production
PageNumber	integer	No	The number of the page to return.	5
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100.	10
ResourceGroupId	string	No	The ID of the resource group to which the replication pair-consistent group belongs.	rg-aekz*****
Name	string	No	The name of the replication pair-consistent group. You can perform a fuzzy search.	pg-name***
Tag	array<object>	No	The tags to add to the replication pair-consistent group. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The key of tag N of the replication pair-consistent group.	tag-key
Value	string	No	The value of tag N of the replication pair-consistent group.	tag-value

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****
NextToken	string	A pagination token.	AAAAAdDWBF2****
ReplicaGroups	array<object>	The information about the replication pair-consistent groups.
ReplicaGroup	object
ReplicaGroupId	string	The IDs of the replication pair-consistent groups.	pg-myreplica****
SourceRegionId	string	The ID of the region in which the primary site is deployed.	cn-beijing
SourceZoneId	string	The ID of the zone in which the primary site is deployed.	cn-beijing-f
DestinationRegionId	string	The ID of the region in which the secondary site is deployed.	cn-shanghai
DestinationZoneId	string	The ID of the zone in which the secondary site is deployed.	cn-shanghai-e
GroupName	string	The name of the replication pair-consistent group.	myreplicagrouptest
Description	string	The description of the replication pair-consistent group.	This is description.
Status	string	The status 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 was created. create_failed: The replication pair-consistent group failed to be created. manual_syncing: Data was being manually synchronized between the disks in the replication pair-consistent group. When data was being manually synchronized for the first time, the replication pair is in this state. syncing: Data was being synchronized between the disks. When data is being asynchronously replicated from the primary disk to the secondary disk again in subsequent operations, the replication pair is in this state. normal: The replication pair was working as expected. When the system finishes replicating data from the primary disk to the secondary disk within the current replication cycle, the replication pair enters this state. stopping: The replication pair was being stopped. stopped: The replication pair was stopped. stop_failed: The replication pair failed to be stopped. failovering: A failover was being performed. failovered: A failover was performed. failover_failed: A failover failed to be performed. reprotecting: A reverse replication was being performed. reprotect_failed: A reverse replication failed to be performed. deleting: The replication pair was being deleted. delete_failed: The replication pair failed to be deleted. deleted: The replication pair was deleted.	created
RPO	long	The recovery point objective (RPO) of the replication pair-consistent group. Unit: seconds.	180
LastRecoverPoint	long	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.	1637835114
Site	string	The type of the site from which the information about the replication pairs and replication pair-consistent group was obtained. Valid values: production: primary site backup: secondary site	production
PairIds	array	The IDs of replication pairs that belong to the replication pair-consistent group.
PairId	byte	The IDs of replication pairs that belong to the replication pair-consistent group.	pair-cn-dsa**,pair-cn-asd**
PairNumber	long	The number of replication pairs that belong to the replication pair-consistent group.	2
PrimaryRegion	string	The initial source region (primary region) of the replication pair-consistent group.	cn-beijing
StandbyRegion	string	The initial destination region (secondary region) of the replication pair-consistent group.	cn-shanghai
PrimaryZone	string	The initial source zone (primary zone) of the replication pair-consistent group.	cn-beijing-h
StandbyZone	string	The initial destination zone (secondary zone) of the replication pair-consistent group.	cn-shanghai-e
Bandwidth	long	The bandwidth value. Unit: Kbit/s. This parameter is not publicly available and has a system-preset value.	0
ResourceGroupId	string	The ID of the resource group to which the replication pair-consistent group belongs.	rg-aek2a*******
Tags	array<object>	The tags of the replication pair-consistent group.
Tag	object
TagKey	string	The tag key of the replication pair-consistent group.	testKey
TagValue	string	The tag value of the replication pair-consistent group.	testValue
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	long	The total number of entries returned.	60

Examples

Sample success responses

JSONformat

{
  "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,
      "PrimaryRegion": "cn-beijing",
      "StandbyRegion": "cn-shanghai\n",
      "PrimaryZone": "cn-beijing-h",
      "StandbyZone": "cn-shanghai-e",
      "Bandwidth": 0,
      "ResourceGroupId": "rg-aek2a*******",
      "Tags": [
        {
          "TagKey": "testKey",
          "TagValue": "testValue"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 60
}

Error codes

HTTP status code	Error code	Error message	Description
403	OperationDenied	The operation is not allowed.	The operation is not supported.
403	OperationDenied.InvalidStatus	The operation is not allowed in current status.	The operation is not supported in the current state.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-08-14	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-07-19	The Error code has changed	View Change Details