文档

DescribeJobErrorCode - 查看任务错误码信息

该接口用于查看DBS任务错误码信息。

调试

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

授权信息

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

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

请求参数

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

全量备份或者恢复任务 ID。

dbstooi0XXXX
Languagestring

错误信息语言,可选 en、cn,默认 en。

en
ClientTokenstring

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

ETnLKlblzczshOTUbOCzxxxxxxx

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

请求 ID.

1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5
ErrCodestring

错误码。

Param.NotFound
Successboolean

是否成功。

true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
Itemobject

错误码信息。

JobStatestring

任务状态。

init
ErrorMessagestring

标准化错误信息。

Describe preCheck progress failed.
ErrorCodestring

错误码。

failed
JobIdstring

全量备份或者恢复任务 ID。

tooi0XXXX
JobTypestring

DBS 内部任务类型 id。

testId
Languagestring

错误信息语言。

en

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Item": {
    "JobState": "init",
    "ErrorMessage": "Describe preCheck progress failed.",
    "ErrorCode": "failed",
    "JobId": "tooi0XXXX",
    "JobType": "testId",
    "Language": "en"
  }
}

错误码

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

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

变更历史

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