Queries the details of one or more replication pairs in a specific region.

Description

  • The async replication feature is supported in the China (Shanghai), China (Beijing), China (Heyuan), and China (Chengdu) regions.
  • When you call this operation for a specific region, if the primary or secondary disk of a replication pair is located within the region, the information of the replication pair is contained in the response.
  • We recommend that you use the NextToken and MaxResults parameters for a paged query. During a paged query, when you call the DescribeDiskReplicaPairs 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 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

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 DescribeDiskReplicaPairs

The operation that you want to perform. Set the value to DescribeDiskReplicaPairs.

RegionId String Yes cn-beijing

The region ID of the primary disk (source disk) or secondary disk (destination 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.

MaxResults Long No 1

The maximum number of entries to return on each page. Valid values: 1 to 500.

Default value: 10.

NextToken String No AAAAAdDWBF2****

The query token. Set the value to the NextToken value returned in the previous call to the DescribeDiskReplicaPairs operation. Leave this parameter empty the first time you call this operation.

PairIds String No pair-cn-dsa****

The IDs of replication pairs. You can specify the IDs of one or more replication pairs and separate the IDs with commas (,). Example: pair-cn-dsa****,pair-cn-asd****.

This parameter is empty by default, which indicates that all of the replication pairs in the specified region are queried.

Response parameters

Parameter Type Example Description
RequestId String AAA478A0-BEE6-1D42-BEB6-A9CFEAD64B29

The ID of the request.

NextToken String AAAAAdDWBF2****

The query token returned in this call.

ReplicaPairs Array of ReplicaPair

Details about the replication pairs.

ReplicaPairId String pair-cn-dsa****

The ID of the replication pair.

SourceRegion String cn-beijing

The region ID of the primary disk.

SourceDiskId String d-bp131n0q38u3a4zi****

The ID of the primary disk.

DestinationRegion String cn-shanghai

The region ID of the secondary disk.

DestinationDiskId String d-asdfjl2342kj2l3k4****

The ID of the secondary disk.

PairName String TestReplicaPair

The name of the replication pair.

Description String This is description.

The description of the replication pair.

Status String created

The state of the replication pair. Valid values:

  • invalid: The replication pair is valid. When a replication pair becomes abnormal, it enters the invalid state.
  • creating: The replication pair is being created.
  • created: The replication pair is created.
  • create_failed: The replication pair cannot be created.
  • initial_syncing: Data is synchronized between the disks for the first time. After a replication pair is created and activated, the replication pair is in this state the first time data is synchronized from the primary disk to the secondary disk.
  • syncing: Data is being synchronized between the disks. While data is being synchronized from the primary disk to the secondary disk not for the first time, the replication pair is in this state.
  • normal: The replication pair is working normally. 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 is being stopped.
  • stopped: The replication pair is stopped.
  • stop_failed: The replication pair 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 is being deleted.
  • delete_failed: The replication pair cannot be deleted.
  • deleted: The replication pair is deleted.
AsyncCycle Long 900

The interval at which data is asynchronously replicated from the primary disk to the secondary disk. Unit: seconds.

Bandwidth Long 10240

The bandwidth used to asynchronously replicate data from the primary disk to the secondary disk. Unit: Kbit/s.

StatusMessage String PrePayOrderExpired

The message that describes the state of the replication pair. This parameter has a value only when the value of Status is invalid. Valid values:

  • PrePayOrderExpired: The replication pair has expired.
  • DeviceRemoved: The primary or secondary disk has been deleted.
  • DeviceKeyChanged: The DeviceKey mapping of the primary or secondary disk has changed.
LastRPO Long 1637835114000000

The time when data was last replicated from the primary disk to the secondary disk. The value of this parameter is a timestamp.

Examples

Sample requests

https://ebs.cn-beijing.aliyuncs.com/?Action=DescribeDiskReplicaPairs
&RegionId=cn-beijing
&MaxResults=1
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDiskReplicaPairsResponse>
    <ReplicaPairs>
        <Status>created</Status>
        <LastRPO>1637835114000000</LastRPO>
        <DestinationDiskId>d-asdfjl2342kj2l3k4****</DestinationDiskId>
        <Description>This is description.</Description>
        <PairName>TestReplicaPair</PairName>
        <Bandwidth>10240</Bandwidth>
        <DestinationRegion>cn-shanghai</DestinationRegion>
        <ReplicaPairId>pair-cn-dsa****</ReplicaPairId>
        <SourceRegion>cn-beijing</SourceRegion>
        <AsyncCycle>900</AsyncCycle>
        <SourceDiskId>d-bp131n0q38u3a4zi****</SourceDiskId>
        <StatusMessage/>
    </ReplicaPairs>
    <RequestId>AAA478A0-BEE6-1D42-BEB6-A9CFEAD64B29</RequestId>
    <NextToken>AAAAAdDWBF2****</NextToken>
</DescribeDiskReplicaPairsResponse>

JSON format

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

{
  "ReplicaPairs" : [ {
    "Status" : "created",
    "LastRPO" : 1637835114000000,
    "DestinationDiskId" : "d-asdfjl2342kj2l3k4****",
    "Description" : "This is description.",
    "PairName" : "TestReplicaPair",
    "Bandwidth" : 10240,
    "DestinationRegion" : "cn-shanghai",
    "ReplicaPairId" : "pair-cn-dsa****",
    "SourceRegion" : "cn-beijing",
    "AsyncCycle" : 900,
    "SourceDiskId" : "d-bp131n0q38u3a4zi****",
    "StatusMessage" : ""
  } ],
  "RequestId" : "AAA478A0-BEE6-1D42-BEB6-A9CFEAD64B29",
  "NextToken" : "AAAAAdDWBF2****"
}

Error codes

For a list of error codes, visit the API Error Center.