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

接口说明

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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDiskReplicaGroups

系统规定参数。取值:DescribeDiskReplicaGroups

RegionId String cn-beijing

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

MaxResults Long 10

分页查询时每页的最大条目数。取值范围:1~500。

默认值:10。

NextToken String AAAAAdDWBF2****

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

GroupIds String AAAAAdDWBF2****

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

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

Site String production

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

  • 如果不指定该参数,则系统会返回生产站点的复制对记录和状态信息。
  • 如果指定该参数,则系统仅返回指定Site的复制对的记录和状态信息。取值范围:
    • production:生产站点。
    • backup:灾备站点。
PageNumber Integer 5

分页查询时的页码。

PageSize Integer 10

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

取值范围1~100。

ResourceGroupId String rg-aekz*****

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

Tag.N.Key String tag-key

一致性复制组的标签键。

Tag.N.Value String tag-value

一致性复制组的标签值。

返回数据

名称 类型 示例值 描述
RequestId String AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****

请求ID。

NextToken String AAAAAdDWBF2****

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

ReplicaGroups Array of ReplicaGroup

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

ReplicaGroupId String pg-myreplica****

一致性复制组ID。

SourceRegionId String cn-beijing

生产站点所属的地域ID。

SourceZoneId String cn-beijing-f

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

DestinationRegionId String cn-shanghai

灾备站点所属的地域ID。

DestinationZoneId String cn-shanghai-e

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

GroupName String myreplicagrouptest

一致性复制组名称。

Description String This is description.

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

Status String created

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

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

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

LastRecoverPoint Long 1637835114

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

Site String production

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

  • production:生产站点。
  • backup:灾备站点。
PairIds Array of String pair-cn-dsa****,pair-cn-asd****

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

PairNumber Long 2

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

PrimaryRegion String cn-beijing

复制组的初始源地域。

StandbyRegion String cn-shanghai

复制组的初始目的地域。

PrimaryZone String cn-beijing-h

复制组的初始源可用区。

StandbyZone String cn-shanghai-e

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

Bandwidth Long 0

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

ResourceGroupId String rg-aek2a*******

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

Tags Array of Tag

复制组的标签。

TagKey String testKey

复制组的标签键。

TagValue String testValue

复制组的标签值。

PageNumber Integer 1

参数页码。

PageSize Integer 10

参数页行数。

TotalCount Long 60

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

示例

请求示例

http(s)://ecs.aliyuncs.com/?Action=DescribeDiskReplicaGroups
&RegionId=cn-beijing
&MaxResults=10
&NextToken=AAAAAdDWBF2****
&GroupIds=AAAAAdDWBF2****
&Site=production
&公共请求参数

正常返回示例

XML格式

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

<DescribeDiskReplicaGroupsResponse>
    <RequestId>AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****</RequestId>
    <NextToken>AAAAAdDWBF2****</NextToken>
    <ReplicaGroups>
        <ReplicaGroupId>pg-myreplica****</ReplicaGroupId>
        <SourceRegionId>cn-beijing</SourceRegionId>
        <SourceZoneId>cn-beijing-f</SourceZoneId>
        <DestinationRegionId>cn-shanghai</DestinationRegionId>
        <DestinationZoneId>cn-shanghai-e</DestinationZoneId>
        <GroupName>myreplicagrouptest</GroupName>
        <Description>This is description.</Description>
        <Status>created</Status>
        <RPO>180</RPO>
        <LastRecoverPoint>1637835114</LastRecoverPoint>
        <Site>production</Site>
        <PairIds>pair-cn-dsa****,pair-cn-asd****</PairIds>
        <PairNumber>2</PairNumber>
    </ReplicaGroups>
</DescribeDiskReplicaGroupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
  } ]
}

错误码

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. 该请求超时,请稍后再重试。

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