调用DescribeJobErrorCode查看任务错误码信息-数据管理 DMS-阿里云

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dbs:DescribeJobErrorCode

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TaskId	string	是	全量备份或恢复任务 ID。	r1iv62ud****
Language	string	否	错误信息语言，取值如下： en：英文（默认值） cn：中文	en
ClientToken	string	否	用于保证请求的幂等性，防止重复提交请求。	ETnLKlblzczshOTUbOCz****

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码。	200
RequestId	string	请求 ID.	1FC2F86D-AFF4-4ED9-BB25-ADDE196CB2B5
ErrCode	string	错误码。	Param.NotFound
Success	boolean	是否成功。	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
Item	object	错误码信息。
JobState	string	任务状态。	init
ErrorMessage	string	标准化错误信息。	Describe preCheck progress failed.
ErrorCode	string	错误码。	failed
JobId	string	全量备份或者恢复任务 ID。	r1iv62ud****
JobType	string	DBS 内部任务类型 id。	testId
Language	string	错误信息语言。	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": "r1iv62ud****",
    "JobType": "testId",
    "Language": "en"
  }
}

错误码

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

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

变更历史

更多信息，参考变更详情。