DescribeDocParserJobStatus - 查询文档解析任务的状态-数据传输服务(DTS)-阿里云帮助中心

接口说明

地域：仅支持华北 2（北京）。
费用：公测期间可免费使用，暂不收取相关费用。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dtsai:DescribeDocParserJobStatus

get

*全部资源

*

无

dtsai:CallWithBearerToken

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-beijing
JobId	string	是	文档解析任务 ID，通过调用 CreateDocParserJob 获取。	job_abc123
AgentName	string	否	代理名称

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58
Success	boolean	请求是否成功。	true
HttpStatusCode	integer	HTTP 状态码。	200
ErrorCode	string	错误码。	JobNotFound
ErrorMessage	string	错误信息。	The specified job does not exist.
Status	string	任务状态。取值： init：已创建，准备中。 pending：排队中，等待调度执行。 running：处理中，正在解析。 success：已完成，可调用 DescribeDocParserJobResult 获取结果。 failed：已失败，FailureMessage 中有原因。 cancelled：已取消。	running
FailureMessage	string	失败原因，仅 Status 为 failed 时有值。	Failed Message

示例

正常返回示例

JSON格式

{
  "RequestId": "A30D0930-xxxx-xxxx-xxxx-C2C661CC8B58",
  "Success": true,
  "HttpStatusCode": 200,
  "ErrorCode": "JobNotFound",
  "ErrorMessage": "The specified job does not exist.",
  "Status": "running",
  "FailureMessage": "Failed Message"
}

错误码

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

变更历史

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