Queries information about replication pairs in a specific region.
Operation description
Usage notes
- For information about the regions in which async replication is available, see Overview .
- When you call this operation for a specific region, if the primary disk (source disk) or secondary disk (destination disk) of a replication pair resides in the region, information about the replication pair is displayed in the response.
- If you want to perform a paged query, configure the
NextTokenandMaxResultsparameters. During a paged query, when you call the DescribeDiskReplicaPairs operation to retrieve the first page of results, setMaxResultsto limit 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 DescribeDiskReplicaPairs 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
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 Resourcesis 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:DescribeDiskReplicaPairs | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the primary or secondary disk in the replication pair. You can call the DescribeRegions operation to query the most recent list of regions in which async replication is supported. | 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. | 1 |
| 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**** |
| PairIds | string | No | The IDs of replication pairs. You can specify the IDs of one or more replication pairs and separate the IDs with commas (,). Example: This parameter is empty by default, which indicates that all replication pairs in the specified region are queried. You can specify a maximum of 100 replication pair IDs. | pair-cn-dsa**** |
| Site | string | No | The type of the site from which the information of replication pairs is retrieved. Valid value:
Default value: production. | production |
| ReplicaGroupId | string | No | The ID of the replication pair-consistent group. You can specify the ID of a replication pair-consistent group to query the replication pairs in the group. Example: This parameter is empty by default, which indicates that all replication pairs in the specified region are queried. Note
If this parameter is set to -, replication pairs that are not added to any replication pair-consistent groups are returned.
| pg-**** |
| PageNumber | integer | No | The page number. | 5 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 100. | 10 |
| ResourceGroupId | string | No | The ID of the resource group to which the replication pair belongs. | rg-acfmvs****** |
| Name | string | No | The name of the replication pair. Fuzzy search is supported. | name*** |
| Tag | array<object> | No | The tags. Up to 20 tags are supported. | |
| 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 the tag. | TestKey |
| Value | string | No | The value of the tag. | TestValue |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****",
"NextToken": "AAAAAdDWBF2****",
"ReplicaPairs": [
{
"ReplicaPairId": "pair-cn-dsa****",
"SourceRegion": "cn-beijing",
"SourceZoneId": "cn-beijing-a",
"SourceDiskId": "d-bp131n0q38u3a4zi****",
"DestinationRegion": "cn-shanghai",
"DestinationZoneId": "cn-shanghai-b",
"DestinationDiskId": "d-asdfjl2342kj2l3k4****",
"PairName": "TestReplicaPair",
"Description": "This is description.",
"Status": "created",
"RPO": 900,
"Bandwidth": 10240,
"StatusMessage": "PrePayOrderExpired",
"LastRecoverPoint": 1649751977,
"ReplicaGroupId": "pg-xxxx****",
"CreateTime": 1649750977,
"ReplicaGroupName": "pg-name****",
"Site": "production",
"PrimaryRegion": "cn-beijing",
"StandbyRegion": "cn-shanghai",
"PrimaryZone": "cn-beijing-a",
"StandbyZone": "cn-shanghai-b",
"ChargeType": "PREPAY",
"ExpiredTime": 1649750977,
"Tags": [
{
"TagKey": "testKey",
"TagValue": "testValue"
}
],
"ResourceGroupId": "rg-acfmvs*****"
}
],
"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 |
| 2024-06-17 | The Error code has changed | View Change Details |