DescribePreCheckProgressList - 查看预检查进度列表

该接口用于查看备份计划预检查进度和恢复任务预检查进度。

调试

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

授权信息

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

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

请求参数

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

备份计划 ID。

说明 请填入 BackupPlanId 或 RestoreTaskId。
dbsr1l3ro21****
RestoreTaskIdstring

恢复任务 ID。

dbasdsa****
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。

ETnLKlblzczshOTUbOCziJZNwH****

返回参数

名称类型描述示例值
object

返回参数详情如下。

Statusstring

预检查状态,返回值如下:

  • running:运行中
  • failed:失败
  • finish:完成
finish
HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

请求 ID。

C4A45FE1-A903-470D-B113-F12A4DF942AB
Progressinteger

预检查进度,返回值范围:0~100。

100
ErrCodestring

错误码。

Param.NotFound
Successboolean

返回是否成功,返回值如下:

  • true:返回成功
  • false:返回失败
true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
Itemsobject []

进度明细列表。

FinishTimelong

完成时间,格式为 Unix 时间戳。

1704351396000
Statestring

进度状态,返回值如下:

  • init:初始化
  • warning:警告
  • catched:异常
  • running:运行中
  • failed:失败
  • finish:完成
warning
BootTimelong

启动时间,格式为 Unix 时间戳。

1704351395000
JobIdstring

进度 ID。

qxwmxh2b****
Itemstring

检查项编码。

CHECK_BINLOG_ON
ErrMsgstring

异常信息。

java.lang.RuntimeException: Could not find any schema ......
OrderNumstring

序号。

30
Namesstring

检查项分组。

CHECK_BINLOG_ON_DETAIL

示例

正常返回示例

JSON格式

{
  "Status": "finish",
  "HttpStatusCode": 200,
  "RequestId": "C4A45FE1-A903-470D-B113-F12A4DF942AB",
  "Progress": 100,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Items": {
    "PreCheckProgressDetail": [
      {
        "FinishTime": 1704351396000,
        "State": "warning",
        "BootTime": 1704351395000,
        "JobId": "qxwmxh2b****",
        "Item": "CHECK_BINLOG_ON",
        "ErrMsg": "java.lang.RuntimeException: Could not find any schema ......",
        "OrderNum": "30",
        "Names": "CHECK_BINLOG_ON_DETAIL"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史