简介
海报合成任务功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于海报合成任务的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.5.0。
API | 操作描述 |
查询指定的任务 | |
拉取符合条件的任务 | |
取消一个任务,只有未执行的任务才可以被取消 | |
提交一个图片处理任务 |
查询海报合成任务
功能说明
查询指定的任务
使用示例
function describePosterProductionJob() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const jobId = "xxx";const key = `pic_jobs/${jobId}`; // jobId:{jobId};const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'GET', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}describePosterProductionJob()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | pic_jobs/{jobId} | String | 是 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南
批量拉取海报合成任务
功能说明
拉取符合条件的任务
使用示例
function describePosterProductionJobList() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `pic_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: "xxx",// 任务的 Tag;是否必传:是tag: "PosterProduction",// 触发该任务的工作流ID;是否必传:否workflowId: "",// 触发该任务的存量触发任务ID;是否必传:否inventoryTriggerJobId: "",// 该任务的输入文件名,暂仅支持精确匹配;是否必传:否inputObject: "",// Desc 或者 Asc。默认为 Desc;是否必传:否orderByTime: "Desc",// 请求的上下文,用于翻页。上次返回的值;是否必传:否nextToken: "",// 拉取该状态的任务,以,分割,支持多状态: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);}},);}describePosterProductionJobList()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:pic_jobs | String | 是 |
Query | 请求参数 | Object | 否 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
queueId | 拉取该队列 ID 下的任务 | String | 是 |
tag | 任务的 Tag | String | 是 |
workflowId | 触发该任务的工作流 ID | String | 否 |
inventoryTriggerJobId | 触发该任务的存量触发任务 ID | String | 否 |
inputObject | 该任务的输入文件名,暂仅支持精确匹配 | String | 否 |
orderByTime | Desc 或者 Asc。默认为 Desc | String | 否 |
nextToken | 请求的上下文,用于翻页。上次返回的值 | String | 否 |
size | 拉取的最大任务数。默认为10。最大为100 | Number | 否 |
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 |
相关链接
API 文档
功能指南
取消海报合成任务
功能说明
取消一个任务,只有未执行的任务才可以被取消。
使用示例
function cancelPosterProductionJob() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const jobId = "xxx";const key = `jobs/${jobId}?cancel`; // jobId:{jobId};const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;cos.request({Method: 'PUT', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}cancelPosterProductionJob()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:PUT | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | jobs/{jobId}?cancel | String | 是 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南
提交海报合成任务
功能说明
提交一个海报合成任务
使用示例
function createPosterProductionJob() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `pic_jobs` //const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {// 创建任务的 Tag:PosterProduction;是否必传:是Tag: "PosterProduction",// 待操作的媒体信息;是否必传:是Input: {// 媒体文件名;是否必传:是Object: "1.jpeg ",},// 操作规则;是否必传:是Operation: {// 指定该任务的参数;是否必传:否PosterProduction: {// ;是否必传:是TemplateId: "xxx",Info: {main: "https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/1.jpeg",text_main: "demo"}},// 结果输出地址;是否必传:是Output: {// 存储桶的地域;是否必传:是Region: config.Region,// 存储结果的存储桶;是否必传:是Bucket: config.Bucket,// 结果文件的名字;是否必传:是Object: "test.jpg",},// 透传用户信息, 可打印的 ASCII 码, 长度不超过1024;是否必传:否UserData: "",// 任务优先级,级别限制:0 、1 、2 。级别越大任务优先级越高,默认为0;是否必传:否JobLevel: "0",},// 任务所在的队列 ID;是否必传:否QueueId: "",// 任务回调格式,JSON 或 XML,默认 XML,优先级高于队列的回调格式;是否必传:否CallBackFormat: "",// 任务回调类型,Url 或 TDMQ,默认 Url,优先级高于队列的回调类型;是否必传:否CallBackType: "Url",// 任务回调地址,优先级高于队列的回调地址。设置为 no 时,表示队列的回调地址不产生回调;是否必传:否CallBack: "",}});cos.request({Method: 'POST', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Body: body, // 请求体参数,必须ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}createPosterProductionJob()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:POST | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:pic_jobs | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Object | 是 |
回调函数说明
function(err, data) { ... }
相关链接
API 文档
功能指南