文档

DescribeRestorePlans - 查询防勒索恢复任务

更新时间:

查询防勒索恢复任务列表。

调试

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

授权信息

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

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

请求参数

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

指定要查询的服务器名称。

sql-test-001
PageSizeinteger

指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 20 条数据。

说明 建议 PageSize 取值不要为空。
20
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
Statusstring

备份计划状态。取值包括:

  • init:初始化中
  • created:创建中
  • running:执行中
  • completed:执行成功
  • error:执行失败
  • restoring:恢复中
running

返回参数

名称类型描述示例值
object

请求返回数据。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

BE120DAB-F4E7-4C53-ADC3-A97578AB****
PageInfoobject

页面显示信息。

CurrentPageinteger

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页显示的备份恢复任务的数量。

20
TotalCountinteger

查询到的备份恢复任务的总数量。

33
Countinteger

当前页面显示的备份恢复任务的数量。

20
RestorePlansobject []

恢复任务的集合。

Statusstring

备份计划状态。取值包括:

  • init:初始化中
  • created:创建中
  • running:执行中
  • completed:执行成功
  • error:执行失败
  • restoring:恢复中
running
RestorePointlong

恢复时间点。

165875100****
UpdatedTimelong

备份任务最后更新的时间戳,单位为毫秒。

166849080****
DatabaseNamestring

数据库的名称。

Bankup****
InstanceNamestring

恢复服务器实例的名称。

sql-test-001
TargetInstanceNamestring

目标服务器实例名称。

hbr-detection-hh
TargetDatabaseNamestring

目标数据库名称。

OABak
PolicyNamestring

数据库防勒索备份策略的名称。

KtDataBase
PolicyIdlong

数据库防勒索备份策略的 ID。

123
TargetInstanceIdstring

目标服务器实例 ID。

i-2zehqflgbl9ep2he****
CreatedTimelong

创建恢复任务的时间戳,单位为毫秒。

1655174753****

示例

正常返回示例

JSON格式

{
  "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578AB****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 33,
    "Count": 20
  },
  "RestorePlans": [
    {
      "Status": "running",
      "RestorePoint": 0,
      "UpdatedTime": 0,
      "DatabaseName": "Bankup****",
      "InstanceName": "sql-test-001",
      "TargetInstanceName": "hbr-detection-hh",
      "TargetDatabaseName": "OABak",
      "PolicyName": "KtDataBase",
      "PolicyId": 123,
      "TargetInstanceId": "i-2zehqflgbl9ep2he****",
      "CreatedTime": 0
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

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