DescribeRecoveryPlans - 查询恢复计划列表

查询站点对中的恢复计划列表。

调试

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

授权信息

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

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

请求参数

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

站点对 ID。

s-0005qxusucbii5ab6wuj
PageNumberinteger

分页查询时设置的页数,默认值为 1。

1
PageSizeinteger

分页查询时设置的每页行数,默认值为 10。

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

F2812CD7-03E7-5774-9EE5-827D8398A670
Successboolean

是否成功。

True
Codestring

接口返回码。

200
Messagestring

返回信息。

successful
PageSizeinteger

分页查询时的每页行数,最大值:100 默认值:10

10
PageNumberinteger

分页查询的当前页码。

1
TotalCountinteger

恢复计划数量。

1
RecoveryPlansarray<object>

恢复计划列表。

recoveryPlanobject

恢复计划详情。

Statusstring

恢复计划状态。其中,

  • creating:创建中
  • updating:更新中
  • deleting:删除中
  • failed:失败
  • init:已初始化
  • running:执行中
init
Directionstring

恢复计划的方向,支持 forward

forward
Namestring

恢复计划名称。

test-1
RecoveryPlanIdstring

恢复计划 ID。

rp-xxxxxxxxxxxxxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "F2812CD7-03E7-5774-9EE5-827D8398A670",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 1,
  "RecoveryPlans": {
    "recoveryPlan": [
      {
        "Status": "init",
        "Direction": "forward",
        "Name": "test-1",
        "RecoveryPlanId": "rp-xxxxxxxxxxxxxxxxxx"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-09API 内部配置变更,不影响调用查看变更详情