文档

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

更新时间:

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

接口说明

  • 异步复制功能支持的地域请参见云盘异步复制概述

  • 当您指定某一地域进行查询后,如果异步复制关系中主盘或者从盘属于该地域,则查询结果中将包含该异步复制关系的信息。

  • 当您需要分页查询时,请使用MaxResultsNextToken参数进行查询。具体使用说明:分页查询首页时,设置MaxResults以限制返回信息的条目数,返回结果中的 NextToken 将作为查询后续页的凭证。查询后续页时,将 NextToken 参数设置为上一次返回结果中获取到的 NextToken 作为查询凭证,并设置 MaxResults 限制返回条目数。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ebs:DescribeDiskReplicaPairsRead
  • DiskReplicaPair
    acs:ebs:{#regionId}:{#accountId}:diskreplicapair/*
  • DiskReplicaPair
    acs:ebs:{#regionId}:{#accountId}:diskreplicapair/{#ReplicaPairId}

请求参数

名称类型必填描述示例值
RegionIdstring

异步复制关系中主盘或从盘所属的地域 ID。您可以调用 DescribeRegions 查询异步复制功能支持的地域信息。

cn-beijing
MaxResultslong

本次调用期望查询的最大条目数。可配合 NextToken 参数一起使用。

取值范围:1~500。

默认值:10。

1
NextTokenstring

查询凭证(Token)。取值为上一次调用该接口返回的 NextToken 参数值,初次调用接口时无需设置该参数。如果设置了 NextToken,则请求参数 PageSize 和 PageNumber 将失效,且返回数据中的 TotalCount 无效。

AAAAAdDWBF2****
PairIdsstring

异步复制关系 ID 列表。您可以指定一个或多个异步复制关系 ID 进行查询。格式为:pair-cn-dsa****,pair-cn-asd****

默认值为空,表示查询当前地域下所有的异步复制关系。最多允许填写 100 个复制关系 ID。

pair-cn-dsa****
Sitestring

获取本 Region 为生产站点或灾备站点的复制对数据。取值范围:

  • production:生产站点。

  • backup:灾备站点。

默认值:production。

production
ReplicaGroupIdstring

一致性复制组 ID,您可以指定一个一致性复制组 ID 来查询组内的复制对。格式为:pg-****

默认值为空,表示查询当前地域下所有的异步复制关系。

说明 当该参数为-时,返回不在任何一致性组中的复制对。
pg-****
PageNumberinteger

分页查询时的页码。

5
PageSizeinteger

分页查询时设置的每页行数。 取值范围 1-100。

10
ResourceGroupIdstring

异步复制对所在的企业资源组 ID。

rg-acfmvs******
Tagobject []

标签列表,最多包含 20 个子项。

Keystring

异步复制对的标签键。

TestKey
Valuestring

异步复制对的标签值。

TestValue

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****
NextTokenstring

本次调用返回的查询凭证(Token)。

AAAAAdDWBF2****
ReplicaPairsobject []

异步复制关系的信息组成的集合。

ReplicaPairIdstring

异步复制关系的 ID。

pair-cn-dsa****
SourceRegionstring

源云盘(主盘)所属的地域信息。

cn-beijing
SourceZoneIdstring

主盘所属的可用区。

cn-beijing-a
SourceDiskIdstring

源云盘(主盘)的云盘 ID。

d-bp131n0q38u3a4zi****
DestinationRegionstring

目标云盘(从盘)所属的地域信息。

cn-shanghai
DestinationZoneIdstring

从盘所属的可用区。

cn-shanghai-b
DestinationDiskIdstring

目标云盘(从盘)的云盘 ID。

d-asdfjl2342kj2l3k4****
PairNamestring

异步复制关系的名称。

TestReplicaPair
Descriptionstring

异步复制关系的描述信息。

This is description.
Statusstring

异步复制关系的状态。可能值:

  • 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
RPOlong

复制对的 RPO 值。单位:秒。

900
Bandwidthlong

异步复制时使用的带宽。单位:Kbps。

10240
StatusMessagestring

异步复制关系的状态提示信息。当Status=invalidStatus=create_failed时,该参数有返回值。可能值:

  • PrePayOrderExpired:包年包月的异步复制关系已过期。
  • PostPayOrderCeaseService:按量付费的异步复制关系停止服务,一般是由于用户欠费引起。
  • DeviceRemoved:主盘或者从盘被删除。
  • DeviceKeyChanged:主盘或从盘的DeviceKey映射发生变化。
  • DeviceSizeChanged:主盘或从盘的DeviceSize发生变化。
  • OperationDenied.QuotaExceed:创建复制对数量超过规格。
PrePayOrderExpired
LastRecoverPointlong

异步复制关系最近一次异步复制操作完成的时间。该参数以时间戳的形式提供返回值。单位:秒。

1649751977
ReplicaGroupIdstring

所属的一致性复制组 ID。

pg-xxxx****
CreateTimelong

创建时间。该参数以时间戳的形式提供返回值。单位:秒。

1649750977
ReplicaGroupNamestring

所属的一致性复制组名称。

pg-name****
Sitestring

复制对和一致性复制组的站点信息来源。可能值:

  • production:生产站点。

  • backup:灾备站点。

production
PrimaryRegionstring

异步复制关系的初始源地域。

cn-beijing
StandbyRegionstring

异步复制关系的初始目的地域。

cn-shanghai
PrimaryZonestring

异步复制关系的初始源可用区。

cn-beijing-a
StandbyZonestring

异步复制关系的初始目的可用区。

cn-shanghai-b
ChargeTypestring

异步复制关系的付费方式。 可能值:

  • PREPAY:包年包月。
  • POSTPAY:按量付费。
PREPAY
ExpiredTimelong

异步复制关系的过期时间。该参数以时间戳的形式提供返回值。单位:秒。

1649750977
Tagsobject []

异步复制对的标签。

TagKeystring

异步复制对的标签键。

testKey
TagValuestring

异步复制对的标签值。

testValue
ResourceGroupIdstring

异步复制对所在的企业资源组 ID。

rg-acfmvs*****
PageNumberinteger

分页查询时的页码。

1
PageSizeinteger

分页查询时设置的每页行数。

10
TotalCountlong

分页查询时的结果总条数。

60

示例

正常返回示例

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

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈