简介
本文档提供关于文档预览队列接口的 API 概览以及 SDK 示例代码。
| API | 说明 |
| 查询文档预览队列 | 查询文档预览队列信息 |
| 更新文档预览队列 | 更新文档预览队列信息 |
查询文档预览队列
功能说明
用于查询文档预览队列。
示例代码
function describeDocProcessQueues() { var config = { // 需要替换成您自己的存储桶信息 Bucket: 'examplebucket-1250000000', /* 存储桶，必须 */ Region: 'COS_REGION', /* 存储桶所在地域，必须字段 */ }; var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/docqueue'; var url = 'https://' + host; cos.request({ Method: 'GET', Key: 'docqueue', Url: url, Query: { // queueIds: '', /* 非必须，队列 ID，以“,”符号分割字符串 */ // state: '', /* 非必须，可选Active或Paused */ // pageNumber: 1, /* 非必须，第几页 */ // pageSize: 2, /* 非必须，每页个数 */ }, }, function(err, data){ console.log(err || data); });}describeDocProcessQueues();
参数说明
| 参数名称 | 描述 | 类型 |
| queueIds | 队列 ID，以“,”符号分割字符串 | String |
| state | Active 表示队列内的作业会被文档预览服务调度执行 Paused 表示队列暂停，作业不再会被文档预览服务调度执行，队列内的所有作业状态维持在暂停状态，已经处于执行中的任务将继续执行，不受影响 | String |
| pageNumber | 第几页 | int |
| pageSize | 每页个数 | int |
返回结果说明
详情请参见 查询文档转码队列。
| 参数名称 | 描述 | 类型 |
| 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 | 队列总数 | Int |
| – – PageNumber | 当前页数，同请求中的 pageNumber | Int |
| – – PageSize | 每页个数，同请求中的 pageSize | Int |
| – – QueueList | 队列数组 | Container |
| – – – NonExistPIDs | 不存在的队列 ID 列表 | String 数组 |
| – – – QueueId | 队列 ID | String |
| – – – Name | 队列名字 | String |
| – – – State | 当前状态，Active 或者 Paused | String |
| – – – NotifyConfig | 回调配置 | Container |
| – – – – MaxSize | 队列最大长度 | Int |
| – – – – MaxConcurrent | 当前队列最大并行执行的任务数 | Int |
| – – – – UpdateTime | 更新时间 | String |
| – – – – CreateTime | 创建时间 | String |
| – – – – Url | 回调地址 | String |
| – – – – State | 开关状态，On 或者 Off | String |
| – – – – Type | 回调类型，Url | String |
| – – – – Event | 触发回调的事件 | String |
更新文档预览队列
功能说明
用于更新文档预览队列。
请求示例
function updateDocProcessQueue() { var config = { // 需要替换成您自己的存储桶信息 Bucket: 'examplebucket-1250000000', /* 存储桶，必须 */ Region: 'COS_REGION', /* 存储桶所在地域，必须字段 */ }; // queueId 可通过查询文档预览队列获得 var queueId = 'pa2e2c3d3fae042de909cafc16f1d8xxx'; var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/docqueue/' + queueId; var url = 'https://' + host; var body = COS.util.json2xml({ Request: { Name: 'queue-doc-process-1', // Name可通过查询文档预览队列获得 QueueID: queueId, State: 'Active', NotifyConfig: { State: 'Off', } } }); cos.request({ Method: 'PUT', Key: 'docqueue/' + queueId, Url: url, Body: body, ContentType: 'application/xml', }, function(err, data){ console.log(err || data); });}updateDocProcessQueue();
参数说明
| 参数名称 | 描述 | 类型 |
| Name | 队列名称 | String |
| QueueID | 队列 ID | String |
| State | 队列状态 | String |
| NotifyConfig | 通知渠道，详情请参见 DocProcessQueue.NotifyConfig | Container |
| – Url | 回调配置 | String |
| – Type | 回调类型，普通回调：Url | String |
| – Event | 回调事件，文档预览任务完成 | String |
| – State | 回调开关，Off，On | Container |
返回结果说明
详情请参见 更新文档转码队列。
| 参数名称 | 描述 | 类型 |
| 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 | 队列信息，详情请参见 DescribeDocProcessQueues 中的 Response.QueueList | Container |
对象存储官网1折活动，限时活动，即将结束，速速收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利。同意关联立享优惠
转转请注明出处：https://www.yunxiaoer.com/145858.html
