功能描述
拉取批量数据处理任务列表。
授权说明
服务开通
注意:
数据万象绑定后,如果您手动对存储桶进行数据万象的解绑操作,将无法继续使用该功能。
使用限制
请求
请求示例
GET /inventorytriggerjob?size=&states=&startCreationTime=&endCreationTime= HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>
说明:
请求头
请求体
该请求无请求体。
请求参数
参数的具体内容如下:
名称 | 描述 | 类型 | 是否必选 |
nextToken | 请求的上下文,用于翻页。上次返回的值 | String | 否 |
size | 拉取的最大任务数。默认为10。最大为100 | Integer | 否 |
type | 拉取批量任务类型,工作流类型 Workflow 、任务类型 Job | String | 否 |
orderByTime | 排序字段的排序方式。取值如下: Asc:升序; Desc(默认):降序。 | String | 否 |
states | 拉取该状态的任务,支持多状态,不同状态之间以 , 分割。可选值如下:All(默认值):包含以下所有状态 Submitted:已提交,待执行 Running:执行中 Success:执行成功 Failed:执行失败 Pause:任务暂停,当暂停队列时,待执行的任务会变为暂停状态 Cancel:任务被取消执行 | String | 否 |
startCreationTime | 拉取创建时间大于等于该时间的任务。格式为: %Y-%m-%dT%H:%m:%S%z | String | 否 |
endCreationTime | 拉取创建时间小于等于该时间的任务。格式为: %Y-%m-%dT%H:%m:%S%z | String | 否 |
workflowId | String | 否 | |
jobId | String | 否 | |
name | 批量触发任务名称 | String | 否 |
响应
响应头
响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response><RequestId></RequestId><JobsDetail>...</JobsDetail><NextToken></NextToken></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
RequestId | Response | 请求的唯一 ID | String |
JobsDetail | Response | 任务的详细信息 | Container 数组 |
NextToken | Response | 翻页的上下文 Token | String |
对于不同的触发方式,JobsDetail 的内容不同,请参照以下链接:
工作流
独立任务
错误码
实际案例
请求
GET /inventorytriggerjob HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comAuthorization:q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=**************************************************
响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 666Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=<Response><RequestId>NjJiZDU1ZmZfOTBmYTUwNjRfNzdjY18xYQ==</RequestId><JobsDetail><Code>Success</Code><Type>Workflow</Type><Message/><Name>demo</Name><JobId>b3deffea2f84911ec9cb15254008618d9</JobId><State>Running</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>-</StartTime><EndTime>-</EndTime><Input><Prefix>input</Prefix></Input><Operation><TimeInterval><Start>2022-02-01T12:00:00+0800</Start><End>2022-05-01T12:00:00+0800</End></TimeInterval><WorkflowIds>w7476ff3564ee45b7b490d64bccaba6cc</WorkflowIds></Operation></JobsDetail><JobsDetail><Code>Success</Code><Type>Job</Type><Message/><Name>demo</Name><JobId>be8f65004eb8511eaaed4f377124a303c</JobId><State>Running</State><CreationTime>2022-06-27T15:23:10+0800</CreationTime><StartTime>2022-06-27T15:23:11+0800</StartTime><EndTime>2022-06-27T15:25:10+0800</EndTime><Input><Prefix>input</Prefix></Input><Operation><TimeInterval><Start>2022-02-01T12:00:00+0800</Start><End>2022-05-01T12:00:00+0800</End></TimeInterval><QueueId>p893bcda225bf4945a378da6662e81a89</QueueId><UserData>this is my inventorytriggerjob</UserData><CallBack>https://www.callback.com</CallBack><JobParam><TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId></JobParam><Output><Region>ap-chongqing</Region><Bucket>test-1234567890</Bucket><Object>output/${InventoryTriggerJobId}/out.mp4</Object></Output><JobLevel>0</JobLevel></Operation></JobsDetail><NextToken>25</NextToken></Response>