DescribeDiskReplicaPairs - 云服务器 ECS

接口说明

异步复制功能支持的地域请参见云盘异步复制概述。
当您指定某一地域进行查询后，如果异步复制关系中主盘或者从盘属于该地域，则查询结果中将包含该异步复制关系的信息。
当您需要分页查询时，请使用MaxResults与NextToken参数进行查询。具体使用说明：分页查询首页时，设置MaxResults以限制返回信息的条目数，返回结果中的NextToken将作为查询后续页的凭证。查询后续页时，将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证，并设置MaxResults限制返回条目数。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDiskReplicaPairs	系统规定参数。取值：DescribeDiskReplicaPairs。
RegionId	String	是	cn-beijing	异步复制关系中主盘或从盘所属的地域ID。您可以调用DescribeRegions查询异步复制功能支持的地域信息。
MaxResults	Long	否	1	本次调用期望查询的最大条目数。可配合NextToken参数一起使用。取值范围：1~500。默认值：10。
NextToken	String	否	AAAAAdDWBF2****	查询凭证（Token）。取值为上一次调用该接口返回的NextToken参数值，初次调用接口时无需设置该参数。如果设置了NextToken，则请求参数PageSize和PageNumber将失效，且返回数据中的TotalCount无效。
PairIds	String	否	pair-cn-dsa****	异步复制关系ID列表。您可以指定一个或多个异步复制关系ID进行查询。格式为：`pair-cn-dsa**,pair-cn-asd**`。默认值为空，表示查询当前地域下所有的异步复制关系。最多允许填写100个复制关系ID。
Site	String	否	production	获取本Region为生产站点或灾备站点的复制对数据。取值范围： production：生产站点。 backup：灾备站点。默认值：production。
ReplicaGroupId	String	否	pg-****	一致性复制组ID，您可以指定一个一致性复制组ID来查询组内的复制对。格式为：`pg-****`。默认值为空，表示查询当前地域下所有的异步复制关系。说明当该参数为`-`时，返回不在任何一致性组中的复制对。
PageNumber	Integer	否	5	分页查询时的页码。
PageSize	Integer	否	10	分页查询时设置的每页行数。取值范围1-100。
ResourceGroupId	String	否	rg-acfmvs******	异步复制对所在的企业资源组ID。
Tag.N.Key	String	否	TestKey	异步复制对的标签键。
Tag.N.Value	String	否	TestValue	异步复制对的标签值。

返回数据

名称	类型	示例值	描述
RequestId	String	AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****	请求ID。
NextToken	String	AAAAAdDWBF2****	本次调用返回的查询凭证（Token）。
ReplicaPairs	Array of ReplicaPair		异步复制关系的信息组成的集合。
ReplicaPairId	String	pair-cn-dsa****	异步复制关系的ID。
SourceRegion	String	cn-beijing	源云盘（主盘）所属的地域信息。
SourceZoneId	String	cn-beijing-a	主盘所属的可用区。
SourceDiskId	String	d-bp131n0q38u3a4zi****	源云盘（主盘）的云盘ID。
DestinationRegion	String	cn-shanghai	目标云盘（从盘）所属的地域信息。
DestinationZoneId	String	cn-shanghai-b	从盘所属的可用区。
DestinationDiskId	String	d-asdfjl2342kj2l3k4****	目标云盘（从盘）的云盘ID。
PairName	String	TestReplicaPair	异步复制关系的名称。
Description	String	This is description.	异步复制关系的描述信息。
Status	String	created	异步复制关系的状态。可能值： invalid：失效。该状态表示异步复制关系存在异常。 creating：创建中。 created：已创建。 create_failed：创建失败。 initial_syncing：初始同步中。异步复制在创建并启动后，主盘数据初次异步复制到从盘的过程中，将处于该状态。 manual_syncing：手动同步中。手动同步，同步完成后恢复到stopped状态。如果是第一次单次同步，则同步中也显示为状态manual_syncing。 syncing：同步中。主盘和从盘之间非第一次进行异步复制数据时，将处于该状态。 normal：正常。当异步复制的当前周期内数据复制完成时，将处于该状态。 stopping：停止中。 stopped：已停止。 stop_failed：停止失败。 failovering：故障切换中。 failovered：故障切换完成。 failover_failed：故障切换失败。 reprotecting：反向复制操作中。 reprotect_failed：反向复制失败。 deleting：删除中。 delete_failed：删除失败。 deleted：已删除。
RPO	Long	900	复制对的RPO值。单位：秒。
Bandwidth	Long	10240	异步复制时使用的带宽。单位：Kbps。
StatusMessage	String	PrePayOrderExpired	异步复制关系的状态提示信息。当`Status=invalid`或`Status=create_failed`时，该参数有返回值。可能值： PrePayOrderExpired：包年包月的异步复制关系已过期。 PostPayOrderCeaseService：按量付费的异步复制关系停止服务，一般是由于用户欠费引起。 DeviceRemoved：主盘或者从盘被删除。 DeviceKeyChanged：主盘或从盘的`DeviceKey`映射发生变化。 DeviceSizeChanged：主盘或从盘的`DeviceSize`发生变化。 OperationDenied.QuotaExceed：创建复制对数量超过规格。
LastRecoverPoint	Long	1649751977	异步复制关系最近一次异步复制操作完成的时间。该参数以时间戳的形式提供返回值。单位：秒。
ReplicaGroupId	String	pg-xxxx****	所属的一致性复制组ID。
CreateTime	Long	1649750977	创建时间。该参数以时间戳的形式提供返回值。单位：秒。
ReplicaGroupName	String	pg-name****	所属的一致性复制组名称。
Site	String	production	复制对和一致性复制组的站点信息来源。可能值： production：生产站点。 backup：灾备站点。
PrimaryRegion	String	cn-beijing	异步复制关系的初始源地域。
StandbyRegion	String	cn-shanghai	异步复制关系的初始目的地域。
PrimaryZone	String	cn-beijing-a	异步复制关系的初始源可用区。
StandbyZone	String	cn-shanghai-b	异步复制关系的初始目的可用区。
ChargeType	String	PREPAY	异步复制关系的付费方式。可能值： PREPAY：包年包月。 POSTPAY：按量付费。
ExpiredTime	Long	1649750977	异步复制关系的过期时间。该参数以时间戳的形式提供返回值。单位：秒。
Tags	Array of Tag		异步复制对的标签。
TagKey	String	testKey	异步复制对的标签键。
TagValue	String	testValue	异步复制对的标签值。
ResourceGroupId	String	rg-acfmvs*****	异步复制对所在的企业资源组ID。
PageNumber	Integer	1	分页查询时的页码。
PageSize	Integer	10	分页查询时设置的每页行数。
TotalCount	Long	60	分页查询时的结果总条数。

示例

请求示例

http(s)://ebs.cn-beijing.aliyuncs.com/?Action=DescribeDiskReplicaPairs
&RegionId=cn-beijing
&MaxResults=1
&NextToken=AAAAAdDWBF2****
&PairIds=pair-cn-dsa****
&Site=production
&ReplicaGroupId=pg-xxxx****
&公共请求参数

正常返回示例

XML格式

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

<DescribeDiskReplicaPairsResponse>
    <RequestId>AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****</RequestId>
    <NextToken>AAAAAdDWBF2****</NextToken>
    <ReplicaPairs>
        <ReplicaPairId>pair-cn-dsa****</ReplicaPairId>
        <SourceRegion>cn-beijing</SourceRegion>
        <SourceZoneId>cn-beijing-a</SourceZoneId>
        <SourceDiskId>d-bp131n0q38u3a4zi****</SourceDiskId>
        <DestinationRegion>cn-shanghai</DestinationRegion>
        <DestinationZoneId>cn-shanghai-b</DestinationZoneId>
        <DestinationDiskId>d-asdfjl2342kj2l3k4****</DestinationDiskId>
        <PairName>TestReplicaPair</PairName>
        <Description>This is description.</Description>
        <Status>created</Status>
        <RPO>900</RPO>
        <Bandwidth>10240</Bandwidth>
        <StatusMessage>PrePayOrderExpired</StatusMessage>
        <LastRecoverPoint>1649751977</LastRecoverPoint>
        <ReplicaGroupId>pg-xxxx****</ReplicaGroupId>
        <CreateTime>1649750977</CreateTime>
        <ReplicaGroupName>pg-name****</ReplicaGroupName>
        <Site>production</Site>
        <PrimaryRegion>cn-beijing</PrimaryRegion>
        <StandbyRegion>cn-shanghai</StandbyRegion>
        <PrimaryZone>cn-beijing-a</PrimaryZone>
        <StandbyZone>cn-shanghai-b</StandbyZone>
        <ChargeType>PREPAY</ChargeType>
        <ExpiredTime>1649750977</ExpiredTime>
        <ResourceGroupId>rg-acfmvs*****</ResourceGroupId>
        <Tags>
            <TagKey>testKey</TagKey>
            <TagValue>testValue</TagValue>
        </Tags>
    </ReplicaPairs>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>60</TotalCount>
</DescribeDiskReplicaPairsResponse>

JSON格式

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

{
  "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,
    "ResourceGroupId" : "rg-acfmvs*****",
    "Tags" : [ {
      "TagKey" : "testKey",
      "TagValue" : "testValue"
    } ]
  } ],
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 60
}

错误码

HttpCode	错误码	错误信息	描述
403	OperationDenied	The operation is not allowed.	当前操作不允许执行。
403	OperationDenied.InvalidStatus	The operation is not allowed in current status.	当前状态下该操作不允许执行。
403	Forbidden	User is not authorized to operate.	当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403	Forbidden.Action	User is not authorized to operate this action.	当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
404	NoSuchResource	The specified resource does not exist.	指定的资源不存在。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。
504	RequestTimeout	The request is timeout, please try again later.	该请求超时，请稍后再重试。

访问错误中心查看更多错误码。