简介
异步处理队列功能是由 数据万象(Cloud Infinite,CI)提供的,数据万象将处理能力与 COS SDK 完全结合,您可以直接按照本篇文档指引进行使用。
本文档提供关于异步处理队列的相关 API 概览以及 SDK 示例代码。
注意:
COS 小程序 SDK 版本需要大于等于 v1.1.1。
查询文档转码队列
功能说明
本接口用于查询文档转码队列
使用示例
function describeDocProcessQueue() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const key = `docqueue` //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: "",// 1. Active 表示队列内的作业会被文档预览服务调度执行2. Paused 表示队列暂停,作业不再会被文档预览服务调度执行,队列内的所有作业状态维持在暂停状态,已经处于执行中的任务将继续执行,不受影响;是否必传:否state: "Active",// 第几页,默认第一页;是否必传:否pageNumber: "",// 每页个数,默认10个;是否必传:否pageSize: "",},},function (err, data) {if (err) {// 处理请求失败console.log(err);} else {// 处理请求成功console.log(data.Response);}},);}describeDocProcessQueue()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:GET | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:docqueue | String | 是 |
Query | 请求参数 | Object | 否 |
Query 参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
queueIds | 队列 ID,以“,”符号分割字符串 | String | 否 |
state | 1. Active 表示队列内的作业会被文档预览服务调度执行 2. Paused 表示队列暂停,作业不再会被文档预览服务调度执行,队列内的所有作业状态维持在暂停状态,已经处于执行中的任务将继续执行,不受影响 | String | 否 |
pageNumber | 第几页,默认第一页 | String | 否 |
pageSize | 每页个数,默认10个 | String | 否 |
回调函数说明
function(err, data) { ... }
相关链接
更新文档转码队列
功能说明
本接口用于更新文档转码队列
使用示例
function updateProcessQueue() {// sdk引入以及初始化请参考:https://cloud.tencent.com/document/product/436/31953const config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', // 存储桶,必须字段Region: 'COS_REGION', // 存储桶所在地域,必须字段 如 ap-beijing};const queueId = "xxx";const key = `docqueue/${queueId}`;const host = `${config.Bucket}.ci.${config.Region}.myqcloud.com`;const url = `https://${host}/${key}`;const body = COS.util.json2xml({Request: {// 队列名称;是否必传:是Name: "xxx",// 队列 ID;是否必传:是QueueID: queueId,// 队列状态;是否必传:是State: "Active",// 通知渠道;是否必传:是NotifyConfig: {// 回调配置;是否必传:否Url: "",// 回调类型,普通回调:Url;是否必传:否Type: "Url",// 回调事件,文档预览任务完成;是否必传:否Event: "TaskFinish",// 回调开关,Off,On;是否必传:否State: "Off",},}});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);}},);}updateProcessQueue()
参数说明
cos.request 方法参数说明:
参数名称 | 参数描述 | 类型 | 是否必填 |
Method | 固定值:PUT | String | 是 |
Url | 请求url,固定值 | String | 是 |
Key | 固定值:docqueue/{queueId} | String | 是 |
ContentType | 固定值 | String | 是 |
Body | Object | 是 |
回调函数说明
function(err, data) { ... }