简介
图片处理队列功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于图片处理队列的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.5.0。
API | 操作描述 |
本接口用于查询图片处理(异步)队列 | |
本接口用于更新图片处理(异步)的队列 |
查询图片处理(异步)队列
功能说明
本接口用于查询图片处理(异步)队列。
使用示例
function describeImageProcessQueue() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `picqueue` //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,以“,”符号分割字符串;是否必传:否queueIds: "",// Active 表示队列内的作业会被调度执行Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响;是否必传:否state: "Active",// 第几页,默认值1;是否必传:否pageNumber: "",// 每页个数,默认值10;是否必传:否pageSize: "",},},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}describeImageProcessQueue()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:picqueue | String | 是 |
Query | 请求参数 | Object | 是 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
queueIds | 队列 ID,以“,”符号分割字符串 | String | 否 |
state | Active 表示队列内的作业会被调度执行 Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响 | String | 否 |
pageNumber | 第几页,默认值1 | String | 否 |
pageSize | 每页个数,默认值10 | 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 |
相关链接
更新图片处理(异步)队列
功能说明
本接口用于更新图片处理(异步)的队列。
使用示例
function updateImageProcessQueue() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const queueId = "xxx";const key = `picqueue/${queueId}` // queueId:{queueId};const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {// 队列名称,仅支持中文、英文、数字、_、-和*,长度不超过 128;是否必传:是Name: "xxx",// Active 表示队列内的作业会被调度执行Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响;是否必传:是State: "Active",// 回调配置;是否必传:是NotifyConfig: {// 回调开关OffOn;是否必传:否State: "Off",// 回调事件TaskFinish:任务完成WorkflowFinish:工作流完成;是否必传:否// Event: "",// 回调格式XMLJSON;是否必传:否// ResultFormat: "",// 回调类型UrlTDMQ;是否必传:否// Type: "",// 回调地址,不能为内网地址。;是否必传:否// Url: "",// TDMQ 使用模式Topic:主题订阅Queue: 队列服务;是否必传:否// MqMode: "",// TDMQ 所属园区,目前支持园区 sh(上海)、bj(北京)、gz(广州)、cd(成都)、hk(中国香港);是否必传:否// MqRegion: "",// TDMQ 主题名称;是否必传:否// MqName: "",},}});cos.request({Method: 'PUT', // 固定值,必须Key: key, // 必须Url: url, // 请求的url,必须Body: body, // 请求体参数,必须ContentType: 'application/xml', // 固定值,必须},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}updateImageProcessQueue()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:PUT | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | picqueue/{queueId} | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Object | 是 |
回调函数说明
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 |
相关链接