数据万象拉取符合条件的文档转码任务-API 文档-文档中心-腾讯云

功能描述
DescribeDocProcessJobs 用于拉取符合条件（状态、创建时间等）的文档转码任务。
授权说明
通过子账号使用时，需要授予 ci:DescribeDocProcessJobs 权限，详情请参见 数据万象 action。
服务开通
使用该功能需提前开通数据万象，并绑定存储桶。详情请参见 绑定存储桶。
使用该功能需提前通过控制台或接口开通文档处理服务 。详情请参见 开通文档处理服务。
使用限制
使用该接口时，请先确认相关限制条件。详情请参见 使用限制。
﻿
请求
请求示例
GET /doc_jobs?queueId=<queueId>&tag=DocProcess HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
说明
Authorization: Auth String，详情请参见 请求签名 文档。
请求头
此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。
请求体
该请求无请求体。
请求参数
参数的具体内容如下：
节点名称（关键字）
父节点
描述
类型
是否必选
tag
无
任务的 Tag：DocProcess
String
是
queueId
无
拉取该队列 ID 下的任务，可在任务响应内容或控制台中获取
String
否
orderByTime
无
Desc 或者 Asc。默认为 Desc
String
否
nextToken
无
请求的上下文，用于翻页。上次返回的值
String
否
size
无
拉取的最大任务数。默认为10。最大为100
Integer
否
states
无
拉取该状态的任务，以,分割，支持多状态：All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All
String
否
startCreationTime
无
拉取创建时间大于等于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z
String
否
endCreationTime
无
拉取创建时间小于等于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z
String
否
响应
响应头
此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。 
响应体
该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
  <JobsDetail></JobsDetail>
  <NextToken></NextToken>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点 Response 的内容：
节点名称（关键字）
父节点
描述
类型
JobsDetail
Response
任务的详细信息，同 CreateDocProcessJobs 接口中的 Response.JobsDetail 节点
Container
NextToken
Response
翻页的上下文 Token
String
错误码
该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。
实际案例
请求
GET /doc_jobs/queueId=QueueId&tag=DocProcess HTTP/1.1
Accept: */*
Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
响应
<Response>
        <JobsDetail>
                <Code>Success</Code>
                <CreationTime>2020-07-20T10:43:17+0800</CreationTime>
                <EndTime>-</EndTime>
                <Input>
                        <Object>1.docx</Object>
                </Input>
                <JobId>JobId</JobId>
                <Message/>
                <Operation>
                        <DocProcess>
                                <EndPage>1</EndPage>
                                <ImageParams>ImageParams</ImageParams>
                                <SrcType/>
                                <StartPage>1</StartPage>
                                <TgtType>png</TgtType>
                        </DocProcess>
                        <Output>
                                <Bucket>BucketId</Bucket>
                                <Object>file/test-${Page}.jpg</Object>
                                <Region>Region</Region>
                        </Output>
                </Operation>
                <QueueId>QueueId</QueueId>
                <State>Submitted</State>
                <Tag>DocProcess</Tag>
        </JobsDetail>
        <JobsDetail>
                <Code>Success</Code>
                <CreationTime>2020-07-20T10:43:17+0800</CreationTime>
                <EndTime>-</EndTime>
                <Input>
                        <Object>test.docx</Object>
                </Input>
                <JobId>JobId</JobId>
                <Message/>
                <Operation>
                        <DocProcess>
                                <EndPage>1</EndPage>
                                <ImageParams>ImageParams</ImageParams>
                                <SrcType/>
                                <StartPage>1</StartPage>
                                <TgtType>png</TgtType>
                        </DocProcess>
                        <Output>
                                <Bucket>BucketId</Bucket>
                                <Object>file/test-${Page}.jpg</Object>
                                <Region>Region</Region>
                        </Output>
                </Operation>
                <QueueId>QueueId</QueueId>
                <State>Submitted</State>
                <Tag>DocProcess</Tag>
        </JobsDetail>
        <NextToken>19193</NextToken>
</Response>
﻿

节点名称（关键字）	父节点	描述	类型	是否必选
tag	无	任务的 Tag：DocProcess	String	是
queueId	无	拉取该队列 ID 下的任务，可在任务响应内容或控制台中获取	String	否
orderByTime	无	Desc 或者 Asc。默认为 Desc	String	否
nextToken	无	请求的上下文，用于翻页。上次返回的值	String	否
size	无	拉取的最大任务数。默认为10。最大为100	Integer	否
states	无	拉取该状态的任务，以`,`分割，支持多状态：All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All	String	否
startCreationTime	无	拉取创建时间大于等于该时间的任务。格式为：`%Y-%m-%dT%H:%m:%S%z`	String	否
endCreationTime	无	拉取创建时间小于等于该时间的任务。格式为：`%Y-%m-%dT%H:%m:%S%z`	String	否

拉取符合条件的文档转码任务

本页目录：

功能描述

授权说明

服务开通

使用限制

请求

请求示例

请求头

请求体

请求参数

响应

响应头

响应体

错误码

实际案例

请求

响应