DescribeDiskReplicaPairs - 查询一个或多个异步复制关系

查询指定地域下，一个或多个异步复制关系的信息。

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****
NextToken	string	本次调用返回的查询凭证（Token）。	AAAAAdDWBF2****
ReplicaPairs	array<object>	异步复制关系的信息组成的集合。
	object
Site	string	复制对和一致性复制组的站点信息来源。可能值： production：生产站点。 backup：灾备站点。	production
DestinationDiskId	string	目标云盘（从盘）的云盘 ID。	d-asdfjl2342kj2l3k4****
Description	string	异步复制关系的描述信息。	This is description.
StandbyZone	string	异步复制关系的初始目的可用区。	cn-shanghai-b
ResourceGroupId	string	异步复制对所在的企业资源组 ID。	rg-acfmvs*****
DestinationRegion	string	目标云盘（从盘）所属的地域信息。	cn-shanghai
ReplicaPairId	string	异步复制关系的 ID。	pair-cn-dsa****
LastRecoverPoint	integer	异步复制关系最近一次异步复制操作完成的时间。该参数以时间戳的形式提供返回值。单位：秒。	1649751977
ReplicaGroupId	string	所属的一致性复制组 ID。	pg-xxxx****
SourceDiskId	string	源云盘（主盘）的云盘 ID。	d-bp131n0q38u3a4zi****
RPO	integer	复制对的 RPO 值。单位：秒。	900
PairName	string	异步复制关系的名称。	TestReplicaPair
Bandwidth	integer	异步复制时使用的带宽。单位：Kbps。	10240
ExpiredTime	integer	异步复制关系的过期时间。该参数以时间戳的形式提供返回值。单位：秒。	1649750977
PrimaryZone	string	异步复制关系的初始源可用区。	cn-beijing-a
SourceZoneId	string	主盘所属的可用区。	cn-beijing-a
Tags	array<object>	异步复制对的标签。
	object	标签信息。
TagKey	string	异步复制对的标签键。	testKey
TagValue	string	异步复制对的标签值。	testValue
Status	string	异步复制关系的状态。可能值： 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：已删除。	created
PrimaryRegion	string	异步复制关系的初始源地域。	cn-beijing
CreateTime	integer	创建时间。该参数以时间戳的形式提供返回值。单位：秒。	1649750977
SourceRegion	string	源云盘（主盘）所属的地域信息。	cn-beijing
StatusMessage	string	异步复制关系的状态提示信息。当`Status=invalid`或`Status=create_failed`时，该参数有返回值。可能值： PrePayOrderExpired：包年包月的异步复制关系已过期。 PostPayOrderCeaseService：按量付费的异步复制关系停止服务，一般是由于用户欠费引起。 DeviceRemoved：主盘或者从盘被删除。 DeviceKeyChanged：主盘或从盘的`DeviceKey`映射发生变化。 DeviceSizeChanged：主盘或从盘的`DeviceSize`发生变化。 OperationDenied.QuotaExceed：创建复制对数量超过规格。	PrePayOrderExpired
EnableRtc	boolean	是否已开启复制时间控制。若复制对已加入复制组，则与复制组的属性保持一致。
ChargeType	string	异步复制关系的付费方式。可能值： PREPAY：包年包月。 POSTPAY：按量付费。	PREPAY
DestinationZoneId	string	从盘所属的可用区。	cn-shanghai-b
ReplicaGroupName	string	所属的一致性复制组名称。	pg-name****
StandbyRegion	string	异步复制关系的初始目的地域。	cn-shanghai
PageNumber	integer	分页查询时的页码。	1
PageSize	integer	分页查询时设置的每页行数。	10
TotalCount	integer	分页查询时的结果总条数。	60

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。
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.	指定的资源不存在。
504	RequestTimeout	The request is timeout, please try again later.	该请求超时，请稍后再重试。

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

变更历史

更多信息，参考变更详情。