查询指定地域下,一个或多个异步复制关系的信息。
接口说明
-
异步复制功能支持的地域请参见云盘异步复制概述。
-
当您指定某一地域进行查询后,如果异步复制关系中主盘或者从盘属于该地域,则查询结果中将包含该异步复制关系的信息。
-
当您需要分页查询时,请使用
MaxResults
与NextToken
参数进行查询。具体使用说明:分页查询首页时,设置MaxResults
以限制返回信息的条目数,返回结果中的 NextToken 将作为查询后续页的凭证。查询后续页时,将 NextToken 参数设置为上一次返回结果中获取到的 NextToken 作为查询凭证,并设置 MaxResults 限制返回条目数。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ebs:DescribeDiskReplicaPairs | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 异步复制关系中主盘或从盘所属的地域 ID。您可以调用 DescribeRegions 查询异步复制功能支持的地域信息。 | cn-beijing |
MaxResults | long | 否 | 本次调用期望查询的最大条目数。可配合 NextToken 参数一起使用。 取值范围:1~500。 默认值:10。 | 1 |
NextToken | string | 否 | 查询凭证(Token)。取值为上一次调用该接口返回的 NextToken 参数值,初次调用接口时无需设置该参数。如果设置了 NextToken,则请求参数 PageSize 和 PageNumber 将失效,且返回数据中的 TotalCount 无效。 | AAAAAdDWBF2**** |
PairIds | string | 否 | 异步复制关系 ID 列表。您可以指定一个或多个异步复制关系 ID 进行查询。格式为: 默认值为空,表示查询当前地域下所有的异步复制关系。最多允许填写 100 个复制关系 ID。 | pair-cn-dsa**** |
Site | string | 否 | 获取本 Region 为生产站点或灾备站点的复制对数据。取值范围:
默认值:production。 | production |
ReplicaGroupId | string | 否 | 一致性复制组 ID,您可以指定一个一致性复制组 ID 来查询组内的复制对。格式为: 默认值为空,表示查询当前地域下所有的异步复制关系。 说明
当该参数为 - 时,返回不在任何一致性组中的复制对。
| pg-**** |
PageNumber | integer | 否 | 分页查询时的页码。 | 5 |
PageSize | integer | 否 | 分页查询时设置的每页行数。 取值范围 1-100。 | 10 |
ResourceGroupId | string | 否 | 异步复制对所在的企业资源组 ID。 | rg-acfmvs****** |
Name | string | 否 | 复制对名称,支持模糊搜索。 | name*** |
Tag | array<object> | 否 | 标签列表,最多包含 20 个子项。 | |
object | 否 | 标签信息。 | ||
Key | string | 否 | 异步复制对的标签键。 | TestKey |
Value | string | 否 | 异步复制对的标签值。 | TestValue |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 该请求超时,请稍后再重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-14 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-06-17 | OpenAPI 错误码发生变更 | 查看变更详情 |