简介
本文档提供关于图片处理队列接口的 API 概览以及 SDK 示例代码。
注意:
COS Node.js SDK 版本需要大于等于 v2.12.6。
更新图片处理队列
功能说明
用于更新图片处理队列。
示例代码
function updatePicProcessQueue() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var queueId = 'p36e92002ff5b418497076f31d33d4xxx';var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/picqueue/' + queueId;var url = 'https://' + host;var body = COS.util.json2xml({Request: {Name: 'My-Queue-Pic', // 必须,队列名称,长度不超过128State: 'Active', // 必须,Active 表示队列内的作业会被调度执行。Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响。NotifyConfig: { // 必须,回调配置State: 'On', // 必须,回调开关,Off/On,默认OffEvent: 'TaskFinish', // 回调事件,当 State=On时, 必选。任务完成:TaskFinish;工作流完成:WorkflowFinishResultFormat: 'XML', // 非必选,回调格式,JSON/XMLType: 'Url', // 回调类型,当 State=On时, 必选,Url 或 TDMQUrl: 'https://www.example.com', // 回调地址,当 State=On, 且Type=Url时, 必选// MqMode: 'Off', // TDMQ 使用模式,当 State=On, 且Type=TDMQ时, 必选// MqRegion: 'Off', // TDMQ 所属地域,当 State=On, 且Type=TDMQ时, 必选// MqName: 'Off', // TDMQ 主题名称,当 State=On, 且Type=TDMQ时, 必选}}});cos.request({Method: 'POST',Key: 'picqueue/' + queueId,Url: url,Body: body,ContentType: 'application/xml',},function(err, data){console.log(err || data);});}updatePicProcessQueue();
参数说明
Request 中的具体数据描述如下:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Request | 无 | 保存结果的容器 | Container | 是 | 无 | 无 |
Container 节点 Request 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
Name | Request | 队列名称,长度不超过128。 | String | 是 | 无 | 无 |
State | Request | Active 表示队列内的作业会被调度执行。 Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响。 | String | 是 | 无 | 无 |
NotifyConfig | Request | 回调配置。 | Container | 是 | 无 | 无 |
Container 节点 NotifyConfig 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 | 是否必选 | 默认值 | 限制 |
State | Request.NotifyConfig | 回调开关,Off/On | String | 否 | Off | On/Off |
Event | Request.NotifyConfig | 回调事件 | String | 当 State=On 时,必选 | 无 | 任务完成:TaskFinish;工作流完成:WorkflowFinish |
ResultFormat | Request.NotifyConfig | 回调格式 | String | 否 | XML | JSON/XML |
Type | Request.NotifyConfig | 回调类型 | String | 当 State=On 时,必选 | 无 | Url 或 TDMQ |
Url | Request.NotifyConfig | 回调地址 | String | 当 State=On,且Type=Url 时,必选 | 无 | 不能为内网地址 |
MqMode | Request.NotifyConfig | TDMQ 使用模式 | String | 当 State=On,且Type=TDMQ 时,必选 | Queue | 主题订阅:Topic 队列服务: Queue |
MqRegion | Request.NotifyConfig | TDMQ 所属地域 | String | 当 State=On,且Type=TDMQ 时,必选 | 无 | 目前支持地域 sh(上海)、bj(北京)、gz(广州)、cd(成都)、hk(中国香港) |
MqName | Request.NotifyConfig | TDMQ 主题名称 | String | 当 State=On,且Type=TDMQ 时,必选 | 无 | 无 |
返回结果说明
查询图片处理队列
功能说明
用于搜索图片处理队列。
示例代码
function describePicProcessQueues() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/picqueue';var url = 'https://' + host;cos.request({Method: 'GET',Key: 'picqueue',Url: url,Query: {// queueIds: '', /* 非必须,队列 ID,以“,”符号分割字符串 */state: 'Active', /* 非必须,1. Active 表示队列内的作业会被媒体处理服务调度执行。2. Paused 表示队列暂停,作业不再会被媒体处理调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响。 */pageNumber: 1, /* 非必须,第几页,默认值1 */pageSize: 10, /* 非必须,每页个数,默认值10 */},},function(err, data){console.log(err || data);});}describePicProcessQueues();
参数说明
参数名称(关键字) | 描述 | 类型 | 是否必选 |
queueIds | 队列 ID,以“,”符号分割字符串。 | String | 否 |
state | Active 表示队列内的作业会被调度执行。 Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响。 | String | 否 |
pageNumber | 第几页,默认值1。 | String | 否 |
pageSize | 每页个数,默认值10。 | String | 否 |