简介
拉取符合条件的任务列表功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于拉取符合条件的任务列表的相关 API 概览以及 SDK 示例代码。
注意
COS 小程序 SDK 版本需要大于等于 v1.1.1。
API | 操作描述 |
获取符合条件的任务列表 |
获取符合条件的任务列表
功能说明
获取符合条件的任务列表
使用示例
function getJobList() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `jobs`; // 固定值,必须const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Query: {// 拉取该队列 ID 下的任务;是否必传:否// queueId: '',// 拉取队列类型下的任务,和 queueId 不同时生效,同时存在时 queueId 优先;是否必传:否// queueType: '',// 任务的 Tag;是否必传:是,比如查找视频转动图的任务tag: 'Animation',// 触发该任务的工作流ID;是否必传:否workflowId: '',// 触发该任务的存量触发任务ID;是否必传:否// inventoryTriggerJobId: '',// 该任务的输入文件名,暂仅支持精确匹配;是否必传:否// inputObject: '',// Desc 或者 Asc。默认为 Desc;是否必传:否// orderByTime: '',// 请求的上下文,用于翻页。上次返回的值;是否必传:否// nextToken: '',// 拉取的最大任务数。默认为10。最大为100;是否必传:否size: 10,// 拉取该状态的任务,以,分割,支持多状态:All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All;是否必传:否states: 'All',// 拉取创建时间大于该时间的任务。格式为:%Y-%m-%dT%H:%m:%S%z,示例:2001-01-01T00:00:00+0800;是否必传:否// startCreationTime: '',// 拉取创建时间小于该时间的任务。格式为:%Y-%m-%dT%H:%m:%S%z,示例:2001-01-01T23:59:59+0800;是否必传:否// endCreationTime: '',},},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}});}getJobList();
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求 url,固定值 | String | 是 |
Key | 固定值:jobs | String | 是 |
Query | Query 请求参数 | Object | 是 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
queueId | 拉取该队列 ID 下的任务 | String | 否 |
queueType | 拉取队列类型下的任务,和 queueId 不同时生效,同时存在时 queueId 优先 | String | 否 |
tag | 任务的 Tag | 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 | 否 |
回调函数说明
function(err, data) { ... }
参数名称 | 参数描述 | 类型 |
err | Object | |
- statusCode | 请求返回的 HTTP 状态码,例如 200、403、404 等 | Number |
- headers | 请求返回的头部信息 | Object |
data | 请求成功时返回的对象,如果请求发生错误,则为空 | Object |
- statusCode | 请求返回的 HTTP 状态码,例如 200、403、404 等 | Number |
- headers | 请求返回的头部信息 | Object |
- Response | 响应结果 详情请参见 获取符合条件的任务列表 | Object |