有奖:语音产品征文挑战赛火热进行中> HOT

简介

本文档提供关于数据万象文档预览队列的相关 API 概览以及 SDK 示例代码。
API
操作名
操作描述
查询队列
查询当前账号下对应的队列信息
更新队列
接口用于更新队列,修改回调信息

基本操作

查询队列

功能说明

查询当前账号下对应的队列信息。

方法原型

public DocListQueueResponse describeDocProcessQueues(DocQueueRequest request);

参数说明

参数名称
描述
类型
必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
queueIds
队列 ID,以,符号分割字符串
string
state
Active 表示队列内的作业会被文档转码服务调度转码执行
Paused 表示队列暂停,作业不再会被文档转码调度转码执行,队列内的所有作业状态维持在暂停状态,已经处于转码中的任务将继续转码,不受影响
string
pageNumber
第几页
string
pageSize
每页个数
string

返回结果说明

成功:返回队列对象集合信息。
失败:发生错误(如 Bucket 不存在),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

请求示例

//1.创建任务请求对象
DocQueueRequest request = new DocQueueRequest();
//2.添加请求参数 参数详情请见 API 接口文档
request.setBucketName("examplebucket-1250000000");
//3.调用接口,获取任务响应对象
DocListQueueResponse response = client.describeDocProcessQueues(request);

更新队列

功能说明

接口用于更新队列,修改回调信息。

方法原型

public boolean updateDocProcessQueue(DocQueueRequest request);

参数说明

参数名称
描述
类型
必选
bucketName
Bucket 的命名规则为 BucketName-APPID,详情请参见 存储桶概述
String
Name
模板名称,长度限制100字符
string
state
Active 表示队列内的作业会被文档转码服务调度转码执行
Paused 表示队列暂停,作业不再会被文档转码调度转码执行,队列内的所有作业状态维持在暂停状态,已经处于转码中的任务将继续转码,不受影响
string
QueueID
管道 ID
string
NotifyConfig
通知渠道,第三方回调 url
Container
Container 类型 NotifyConfig 的具体数据描述如下:
参数名称
描述
类型
必选
Url
回调 url 地址
String
Type
回调类型,普通回调:Url
String
Event
回调事件,视频转码完成:TransCodingFinish
String
State
回调开关,Off,On
String

返回结果说明

成功: 返回布尔值 true 则修改成功 修改失败则抛出异常。
失败: 发生错误(如身份认证失败),抛出异常 CosClientException 或者 CosServiceException。详情请参见 异常处理

请求示例

//1.创建任务请求对象
DocQueueRequest request = new DocQueueRequest();
//2.添加请求参数 参数详情请见 API 接口文档
request.setBucketName("examplebucket-1250000000");
request.setQueueId("pc02270c617ae4b6d9b0a52cb1cf****");
request.getNotifyConfig().setUrl("http://cloud.tencent.com");
request.getNotifyConfig().setState("On");
request.getNotifyConfig().setEvent("TransCodingFinish");
request.getNotifyConfig().setType("Url");
request.setState("Active");
request.setName("mark");
//3.调用接口,获取任务响应对象
boolean result = client.updateDocProcessQueue(request);