批量拉取海报任务

最近更新时间:2023-11-07 14:01:05

我的收藏

功能描述

拉取符合条件的任务。

授权说明

授权策略中 action 设置为 ci:DescribeMediaJobs 。查看所有 action

服务开通

使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶

使用限制

使用该接口时,请先确认相关限制条件。详情请参见 使用限制

请求

请求示例

GET /pic_jobs?tag=PosterProduction HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>

说明
Authorization: Auth String(详情请参见 请求签名 文档)。
通过子账号使用时,需要授予相关的权限,详情请参见 授权粒度详情 文档。

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求体

该请求无请求体。

请求参数

参数的具体内容如下:
节点名称(关键字)
父节点
描述
类型
是否必选
queueId
拉取该队列 ID 下的任务
String
tag
任务的 Tag,固定值为 PosterProduction
String
workflowId
触发该任务的工作流 ID
String
inventoryTriggerJobId
触发该任务的存量触发任务 ID
String
inputObject
该任务的输入文件名,暂仅支持精确匹配
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,示例:2001-01-01T00:00:00+0800
String
endCreationTime
拉取创建时间小于该时间的任务。格式为:%Y-%m-%dT%H:%m:%S%z,示例:2001-01-01T23:59:59+0800
String

响应

响应头

此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response>
<JobsDetail>
...
</JobsDetail>
<NextToken></NextToken>
</Response>
具体的数据内容如下:
节点名称(关键字)
父节点
描述
类型
Response
保存结果的容器
Container
Container 节点 Response 的内容:
节点名称(关键字)
父节点
描述
类型
JobsDetail
Response
任务的详细信息
Container 数组
NonExistJobId
Response
不存在的任务 ID
String 数组
NextToken
Response
翻页的上下文 Token
String
Container 节点
JobsDetail
的内容:
节点名称(关键字)
父节点
描述
类型
Code
Response.JobsDetail
错误码,只有 State 为 Failed 时有意义
String
Message
Response.JobsDetail
错误描述,只有 State 为 Failed 时有意义
String
JobId
Response.JobsDetail
新创建任务的 ID
String
Tag
Response.JobsDetail
新创建任务的 Tag:StreamExtract
String
State
Response.JobsDetail
任务状态
Submitted:已提交,待执行
Running:执行中
Success:执行成功
Failed:执行失败
Pause:任务暂停,当暂停队列时,待执行的任务会变为暂停状态
Cancel:任务被取消执行
String
CreationTime
Response.JobsDetail
任务的创建时间
String
StartTime
Response.JobsDetail
任务的开始时间
String
EndTime
Response.JobsDetail
任务的结束时间
String
QueueId
Response.JobsDetail
任务所属的 队列 ID
String
Operation
Response.JobsDetail
该任务的规则
Container
Container 节点 Operation 的内容:
节点名称(关键字)
父节点
描述
类型
TemplateId
Response.JobsDetail.Operation
海报合成模板 ID
String
Output
Response.JobsDetail.Operation
同请求中的 Request.Operation.Output
Container
MediaResult
Response.JobsDetail.Operation
输出文件的基本信息,详见 MediaResult ,任务未完成时不返回
Container
UserData
Response.JobsDetail.Operation
同请求中的 Request.Operation.UserData
String
JobLevel
Response.JobsDetail.Operation
同请求中的 Request.Operation.JobLevel
String

错误码

错误码

该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。

实际案例

请求

GET /pic_jobs?queueId=p2911917386e148639319e13c285cc774&tag=PosterProduction HTTP/1.1
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=28e9a4986df11bed0255e97ff90500557e0ea057
Host:test-1234567890.ci.ap-chongqing.myqcloud.com


响应

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 666
Connection: keep-alive
Date: Mon, 18 Jul 2022 19:37:29 GMT
Server: tencent-ci
x-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=

<Response>
<JobsDetail>
<Code>Success</Code>
<Message/>
<JobId>c93984788066911ed89ed352d4d9d2084</JobId>
<State>Submitted</State>
<CreationTime>2022-07-18T15:16:43+0800</CreationTime>
<EndTime>-</EndTime>
<StartTime>-</StartTime>
<QueueId>p2911917386e148639319e13c285cc774</QueueId>
<Tag>PosterProduction</Tag>
<Operation>
<PosterProduction>
<TemplateId>6324349b569067d4d11a2c2c</TemplateId>
<Info>
<Background>https://static.taishan.qq.com/xrdnest/pstemplate/assets/e96c14ea085cda431481e774954fa3a5.png?imageMogr2/format/webp</Background>
<EXPIRY>EXPIRY</EXPIRY>
<MM>MM</MM>
<YY>YY</YY>
<base>https://static.taishan.qq.com/xrdnest/pstemplate/assets/ba206498074a034722a936ec12eef1f6.png?imageMogr2/format/webp</base>
</Info>
</PosterProduction>
<Output>
<Bucket>test-1234567890</Bucket>
<Object>output/out.png</Object>
<Region>ap-chongqing</Region>
</Output>
<TemplateId>t10461fe2bd5a649db9022452ec71e0381</TemplateId>
<TemplateName>test</TemplateName>
<UserData>This is my data.</UserData>
<JobLevel>0</JobLevel>
</Operation>
</JobsDetail>
<JobsDetail>
<Code>Success</Code>
<Message/>
<JobId>c93984788066911ed89ed352d4d9d2084</JobId>
<State>Submitted</State>
<CreationTime>2022-07-18T15:16:43+0800</CreationTime>
<EndTime>-</EndTime>
<StartTime>-</StartTime>
<QueueId>p2911917386e148639319e13c285cc774</QueueId>
<Tag>PosterProduction</Tag>
<Operation>
<PosterProduction>
<TemplateId>6324349b569067d4d11a2c2c</TemplateId>
<Info>
<Background>https://static.taishan.qq.com/xrdnest/pstemplate/assets/e96c14ea085cda431481e774954fa3a5.png?imageMogr2/format/webp</Background>
<EXPIRY>EXPIRY</EXPIRY>
<MM>MM</MM>
<YY>YY</YY>
<base>https://static.taishan.qq.com/xrdnest/pstemplate/assets/ba206498074a034722a936ec12eef1f6.png?imageMogr2/format/webp</base>
</Info>
</PosterProduction>
<Output>
<Bucket>test-1234567890</Bucket>
<Object>output/out.png</Object>
<Region>ap-chongqing</Region>
</Output>
<TemplateId>t10461fe2bd5a649db9022452ec71e0381</TemplateId>
<TemplateName>test</TemplateName>
<UserData>This is my data.</UserData>
<JobLevel>0</JobLevel>
</Operation>
</JobsDetail>
</Response>