一、功能描述
通过工作流触发批量数据处理任务。
二、服务开通
使用该功能需提前 绑定存储桶,开通数据万象服务。
注意:数据万象绑定后,如果你手动对存储桶进行数据万象的解绑操作,将无法继续使用该功能。
三、使用限制
使用该接口时,请先确认相关限制条件。详情请参见 使用限制。
四、请求示例
POST /inventorytriggerjob HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml<body>
注意:说明:
注意:Authorization: Auth String,详情请参见 请求签名 文档。
五、请求头
此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。
六、请求体
该请求操作的实现需要有如下请求体。
<Request> <Name>demo</Name> <Type>Workflow</Type> <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></Request>
具体的数据描述如下:
| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
| Request | 无 | 保存请求的容器 | Container | 是 |
Container 类型 Request 的具体数据描述如下:
| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
| Name | Request | 批量触发任务名称,支持中文、英文、数字、—和_,长度限制128字符 | String | 是 |
| Type | Request | 批量处理任务类型: Workflow | String | 否 |
| Input | Request | 待操作的媒体信息 | Container | 是 |
| Operation | Request | 操作规则 | Container | 是 |
Container 类型 Input 的具体数据描述如下:
| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
| Manifest | Request.Input | COS 清单列表文件名,COS 清单生成的 manifest.json 文件 | String | 否 |
| UrlFile | Request.Input | URL 文件名,文件中每行的 URL 为一个 COS 中对象的访问地址 | String | 否 |
| Prefix | Request.Input | Object 前缀 | String | 否 |
| Object | Request.Input | 媒体文件名 | String | 否 |
Container 类型 Operation 的具体数据描述如下:
| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
| WorkflowIds | Request.Operation | 触发的工作流 ID,详情请参见 创建工作流 | String | 是 |
| TimeInterval | Request.Operation | 按时间过滤的触发范围 | Container | 否 |
Container 类型 TimeInterval 的具体数据描述如下:
| 节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 |
| Start | Request.TimeInterval | 开始时间。格式为:%Y-%m-%dT%H:%m:%S%z,示例:2001-01-01T00:00:00+0800。 | String | 否 |
| End | Request.TimeInterval | 结束时间。格式为:%Y-%m-%dT%H:%m:%S%z,示例:2001-01-01T00:00:00+0800。 | String | 否 |
七、响应头
此接口仅返回公共响应头部,详情请参见 公共响应头部 文档。
八、响应体
该响应体返回为 application/xml 数据,包含完整节点数据的内容展示如下:
<Response> <JobsDetail> <Code>Success</Code> <Message/> <Type>Workflow</Type> <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></Response>
具体的数据内容如下:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| RequestId | Response | 请求的唯一 ID | String |
| JobsDetail | Response | 任务的详细信息 | Container |
Container 节点 JobsDetail 的内容:
| 节点名称(关键字) | 父节点 | 描述 | 类型 |
| Code | Response.JobsDetail | 错误码,当 State 为 Failed 时生效 | String |
| Message | Response.JobsDetail | 错误描述,当 State 为 Failed 时生效 | String |
| Type | Response.JobsDetail | 批量处理任务类型 | String |
| Name | Response.JobsDetail | 新创建任务的名称 | String |
| JobId | Response.JobsDetail | 新创建任务的 ID | String |
| State | Response.JobsDetail | 任务状态。Submitted:已提交,待执行Running:执行中Success:执行成功Failed:执行失败Pause:任务暂停,当暂停队列时,待执行的任务会变为暂停状态Cancel:任务被取消执行 | String |
| CreationTime | Response.JobsDetail | 任务的创建时间 | String |
| StartTime | Response.JobsDetail | 任务的开始时间 | String |
| EndTime | Response.JobsDetail | 任务的结束时间 | String |
| Input | Response.JobsDetail | 同请求中的 Request.Input | Container |
| Operation | Response.JobsDetail | 同请求中的 Request.Operation | Container |
九、错误码
该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。
十、请求
POST /inventorytriggerjob HTTP/1.1Authorization: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=**************************************************Host:bucket-1250000000.ci.ap-beijing.myqcloud.comContent-Length: 166Content-Type: application/xml<Request> <Name>demo</Name> <Type>Workflow</Type> <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></Request>
十一、响应
HTTP/1.1 200 OKContent-Type: application/xmlContent-Length: 230Connection: keep-aliveDate: Mon, 28 Jun 2022 15:23:12 GMTServer: tencent-cix-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=<Response> <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></Response>