Queries the details of one or more replication pair-consistent groups in a specific region.
Operation description
To perform a paged query, set 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
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the replication pair-consistent group. | cn-beijing |
MaxResults | long | No | The maximum number of entries to return on each page. Valid values: 1 to 500. Default value: 10. | 10 |
NextToken | string | No | The query token. Set the value to the NextToken value returned in the previous call to the DescribeDiskReplicaGroups operation. Leave this parameter empty the first time you call this operation. When NextToken is specified, the PageSize and PageNumber request parameters do not take effect and the TotalCount response parameter is invalid. | AAAAAdDWBF2**** |
GroupIds | string | No | The IDs of 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. | 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.
| 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 group belongs. | rg-aekz***** |
Tag | array<object> | No | The resource tags. You can specify up to 20 tags. | |
object | No | The value of tag N used for exact search of EBS resources. The tag value must be 1 to 128 characters in length. Valid values of N: 1 to 20. | ||
Key | string | No | The key of tag N of the replication group. | tag-key |
Value | string | No | The value of tag N to add to the replication group. | tag-value |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 |
---|---|---|
2023-07-19 | The Error code has changed | View Change Details |