文档

DescribeDiskReplicaGroups - 查询一个或多个异步复制组

更新时间:

查询在指定地域下,一个或多个一致性复制组的信息。

接口说明

当您需要分页查询时,请使用 MaxResults 与 NextToken 参数进行查询。

分页查询首页时,设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置 MaxResults 限制返回条目数。

调试

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

授权信息

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

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

请求参数

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

一致性复制组所属的地域 ID。

cn-beijing
MaxResultslong

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

取值范围:1~500。

默认值:10。

10
NextTokenstring

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

AAAAAdDWBF2****
GroupIdsstring

一致性复制组的 ID 列表。您可以指定一个或多个一致性复制组的 ID 进行查询。多个一致性复制组的 ID 之间用半角逗号(,)分隔。

默认值为空,表示查询当前地域下所有的一致性复制组。最多允许填写 100 个复制组 ID。

AAAAAdDWBF2****
Sitestring

查询并返回指定站点的记录,主要应用于跨可用区复制对的场景。

  • 如果不指定该参数,则系统会返回生产站点的复制对记录和状态信息。

  • 如果指定该参数,则系统仅返回指定 Site 的复制对的记录和状态信息。取值范围:

    • production:生产站点。
    • backup:灾备站点。
production
PageNumberinteger

分页查询时的页码。

5
PageSizeinteger

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

10
ResourceGroupIdstring

一致性复制组所在的企业资源组 ID。

rg-aekz*****
Tagobject []

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

Keystring

一致性复制组的标签键。

tag-key
Valuestring

一致性复制组的标签值。

tag-value

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

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

AAAAAdDWBF2****
ReplicaGroupsobject []

一致性复制组的信息组成的集合。

ReplicaGroupIdstring

一致性复制组 ID。

pg-myreplica****
SourceRegionIdstring

生产站点所属的地域 ID。

cn-beijing
SourceZoneIdstring

生产站点所属的可用区 ID。

cn-beijing-f
DestinationRegionIdstring

灾备站点所属的地域 ID。

cn-shanghai
DestinationZoneIdstring

灾备站点所属的可用区 ID。

cn-shanghai-e
GroupNamestring

一致性复制组名称。

myreplicagrouptest
Descriptionstring

一致性复制组的描述信息。

This is description.
Statusstring

一致性复制组的状态。可能值:

  • invalid:失效。该状态表示一致性复制组中复制对存在异常。
  • creating:创建中。
  • created:已创建。
  • create_failed:创建失败。
  • manual_syncing:单次同步中。如果是第一次单次同步,则同步中也显示为该状态。
  • syncing:同步中。主盘和从盘之间非第一次进行异步复制数据时,将处于该状态。
  • normal:正常。当异步复制的当前周期内数据复制完成时,将处于该状态。
  • stopping:停止中。
  • stopped:已停止。
  • stop_failed:停止失败。
  • failovering:故障切换中。
  • failovered:故障切换完成。
  • failover_failed:故障切换失败。
  • reprotecting:反向复制操作中。
  • reprotect_failed:反向复制失败。
  • deleting:删除中。
  • delete_failed:删除失败。
  • deleted:已删除。
created
RPOlong

一致性复制组的 RPO 值。单位:秒。

180
LastRecoverPointlong

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

1637835114
Sitestring

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

  • production:生产站点。
  • backup:灾备站点。
production
PairIdsarray

一致性复制组中包含的复制对 ID 列表。

byte

一致性复制组中包含的复制对 ID 列表。

pair-cn-dsa****,pair-cn-asd****
PairNumberlong

一致性复制组中包含的复制对个数。

2
PrimaryRegionstring

复制组的初始源地域。

cn-beijing
StandbyRegionstring

复制组的初始目的地域。

cn-shanghai
PrimaryZonestring

复制组的初始源可用区。

cn-beijing-h
StandbyZonestring

复制组的初始目的可用区。

cn-shanghai-e
Bandwidthlong

带宽值,单位为 Kbps。该参数暂未开放使用,返回值由系统预设。

0
ResourceGroupIdstring

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

rg-aek2a*******
Tagsobject []

复制组的标签。

TagKeystring

复制组的标签键。

testKey
TagValuestring

复制组的标签值。

testValue
PageNumberinteger

分页查询时的页码。

1
PageSizeinteger

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

10
TotalCountlong

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

60

示例

正常返回示例

JSON格式

{
  "RequestId": "AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****",
  "NextToken": "AAAAAdDWBF2****",
  "ReplicaGroups": [
    {
      "ReplicaGroupId": "pg-myreplica****",
      "SourceRegionId": "cn-beijing",
      "SourceZoneId": "cn-beijing-f",
      "DestinationRegionId": "cn-shanghai",
      "DestinationZoneId": "cn-shanghai-e",
      "GroupName": "myreplicagrouptest",
      "Description": "This is description.",
      "Status": "created",
      "RPO": 180,
      "LastRecoverPoint": 1637835114,
      "Site": "production",
      "PairIds": [
        "pair-cn-dsa****,pair-cn-asd****"
      ],
      "PairNumber": 2,
      "PrimaryRegion": "cn-beijing",
      "StandbyRegion": "cn-shanghai\n",
      "PrimaryZone": "cn-beijing-h",
      "StandbyZone": "cn-shanghai-e",
      "Bandwidth": 0,
      "ResourceGroupId": "rg-aek2a*******",
      "Tags": [
        {
          "TagKey": "testKey",
          "TagValue": "testValue"
        }
      ]
    }
  ],
  "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.该请求超时,请稍后再重试。

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

变更历史

变更时间变更内容概要操作
2023-07-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
  • 本页导读 (1)