帮你快速理解、总结文档立即下载

文件处理队列

最近更新时间:2023-07-12 20:14:11
我的收藏

简介

本文档提供关于文件处理队列接口的 API 概览以及 SDK 示例代码。
API
操作描述
用于更新文件处理队列
用于搜索文件处理队列

更新文件处理队列

功能说明

用于更新文件处理的队列。

示例代码

function updateFileProcessQueue() {
var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
// 任务所在的队列 ID,请使用查询队列(https://cloud.tencent.com/document/product/460/46946)获取或前往万象控制台(https://cloud.tencent.com/document/product/460/46487)在存储桶中查询
var queueId = 'p6160ada105a7408e95aac015f4bf8xxx';
var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/file_queue/' + queueId;
var url = 'https://' + host;
var body = COS.util.json2xml({
Request: {
Name: 'My-Queue-file', // 必须,队列名称,长度不超过128
State: 'Active', // 必须,Active 表示队列内的作业会被调度执行。Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响。
NotifyConfig: { // 必须,回调配置
State: 'On', // 必须,回调开关,Off/On,默认Off
Event: 'TaskFinish', // 回调事件,当 State=On时, 必选。任务完成:TaskFinish;工作流完成:WorkflowFinish
ResultFormat: 'XML', // 非必选,回调格式,JSON/XML
Type: 'Url', // 回调类型,当 State=On时, 必选,Url 或 TDMQ
Url: '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: 'file_queue/' + queueId,
Url: url,
Body: body,
ContentType: 'application/xml',
},
function(err, data){
logger.log(err || data);
});
}
updateFileProcessQueue();

参数说明

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</td>
MqRegion
Request.NotifyConfig
TDMQ 所属地域
String
当 State=On,且Type=TDMQ时,必选
无
目前支持地域 sh(上海)、bj(北京)、gz(广州)、cd(成都)、hk(中国香港)
MqName
Request.NotifyConfig
TDMQ 主题名称
String
当 State=On,且Type=TDMQ时,必选
无
无

返回结果说明

详情请参见 更新文件处理队列 。
参数名称
描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,更多详情请参见 错误码
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- Response
-
Object
- - RequestId
请求的唯一 ID
string
- - Queue
队列信息
Container
- - - QueueId
队列 ID
string
- - - Name
队列名字
string
- - - State
当前状态,Active 或者 Paused
string
- - - MaxSize
队列最大长度
Number
- - - MaxConcurrent
当前队列最大并行执行的任务数
Number
- - - Category
队列类型
string
- - - UpdateTime
更新时间
string
- - - CreateTime
创建时间
string
- - - NotifyConfig
回调配置
Container
- - - - Url
回调地址
string
- - - - State
开关状态
string
- - - - Type
回调类型
string
- - - - Event
回调事件
string
- - - - ResultFormat
回调类型
string
- - - - MqMode
TDMQ 使用模式
string
- - - - MqRegion
TDMQ 所属地域
string
- - - - MqName
TDMQ 主题名称
string

查询文件处理队列

功能说明

用于搜索文件处理队列。

示例代码

function describeFileProcessQueues() {
var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/file_queue';
var url = 'https://' + host;
cos.request({
Method: 'GET',
Key: 'file_queue',
Url: url,
Query: {
// queueIds: '', /* 非必须,队列 ID,以“,”符号分割字符串 */
state: 'Active', /* 非必须,Active 表示队列内的作业会被调度执行。Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响。 */
pageNumber: 1, /* 第几页,默认值1 */
pageSize: 10, /* 非必须,每页个数,默认值10 */
},
},
function(err, data){
logger.log(err || data);
});
}
describeFileProcessQueues();

参数说明

参数名称(关键字)
描述
类型
是否必选
queueIds
队列 ID,以“,”符号分割字符串。请使用查询队列获取或前往万象控制台在存储桶中查询
String
否
state
Active 表示队列内的作业会被调度执行。
Paused 表示队列暂停,作业不再会被调度执行,队列内的所有作业状态维持在暂停状态,已经执行中的任务不受影响。
String
否
pageNumber
第几页,默认值1。
String
否
pageSize
每页个数,默认值10。
String
否

返回结果说明

详情请参见 查询文件处理队列 。
参数名称
描述
类型
err
请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,更多详情请参见 错误码
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
data
请求成功时返回的对象,如果请求发生错误,则为空
Object
- statusCode
请求返回的 HTTP 状态码,例如200、403、404等
Number
- headers
请求返回的头部信息
Object
- Response
-
Object
- - RequestId
请求的唯一 ID
string
- - TotalCount
队列总数
Number
- - PageNumber
当前页数,同请求中的 pageNumber
Number
- - PageSize
每页个数,同请求中的 pageSize
Number
- - NonExistPIDs
不存在的队列 ID 列表
String数组
- - QueueList
队列数组
Array
- - - QueueId
队列 ID
string
- - - Name
队列名字
string
- - - State
当前状态,Active 或者 Paused
string
- - - MaxSize
队列最大长度
Number
- - - MaxConcurrent
当前队列最大并行执行的任务数
Number
- - - Category
队列类型
string
- - - UpdateTime
更新时间
string
- - - CreateTime
创建时间
string
- - - NotifyConfig
回调配置
Container
- - - - Url
回调地址
string
- - - - State
开关状态
string
- - - - Type
回调类型
string
- - - - Event
回调事件
string
- - - - ResultFormat
回调类型
string
- - - - MqMode
TDMQ 使用模式
string
- - - - MqRegion
TDMQ 所属地域
string
- - - - MqName
TDMQ 主题名称
string