tencent cloud

数据万象

动态与公告
产品动态
产品公告
产品简介
产品概述
产品优势
应用场景
功能概览
地域与域名
使用限制
产品计费
计费概述
计费方式
计费项
免费额度
欠费说明
查看消费明细
常见问题
快速入门
注册与登录
绑定存储桶
上传和处理文件
下载和删除文件
解绑存储桶
通过 COS 使用数据万象
能力地图
图片处理
媒体处理
内容审核
AI 内容识别
文档处理
智能语音
文件处理
用户指南
概览
存储桶管理
智能工具箱
任务与工作流
数据监控
用量统计
实践教程
版权保护解决方案
图片处理实践
API 授权策略使用指引
工作流实践
API 文档
API 概览
结构体
公共请求头部
公共响应头部
开通万象服务
图片处理
AI 内容识别
智能语音
媒体处理
内容审核
文档处理
文件处理
任务与工作流
云查毒
错误码
请求签名
SDK 文档
SDK 概览
图片处理 Android SDK
图片处理 iOS SDK
COS Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Go SDK
COS iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
小程序 SDK
SDK 产品个人信息保护规则
安全与合规
权限管理
常见问题
基础设置
文档处理
媒体处理
内容识别
智能语音
服务协议
Service Level Agreement
联系我们
词汇表

异步处理队列接口

PDF
聚焦模式
字号
最后更新时间: 2024-03-04 16:55:55

简介

本文档提供关于文档预览队列接口的 API 概览以及 SDK 示例代码。
API
操作名
操作描述
DescribeDocProcessQueues
查询文档预览队列
查询文档预览队列信息
UpdateDocProcessQueue
更新文档预览队列
更新文档预览队列信息

查询文档预览队列

功能说明

DescribeDocProcessQueues 接口用于查询文档预览队列。

方法原型

func (s *CIService) DescribeDocProcessQueues(ctx context.Context, opt *DescribeDocProcessQueuesOptions) (*DescribeDocProcessQueuesResult, *Response, error)

请求示例

DescribeQueueOpt := &cos.DescribeDocProcessQueuesOptions{
QueueIds: "p111a8dd208104ce3b11c78398f658ca8,p4318f85d2aa14c43b1dba6f9b78be9b3,aacb2bb066e9c4478834d4196e76c49d3",
PageNumber: 1,
PageSize: 2,
}
res, _, err := c.CI.DescribeDocProcessQueues(context.Background(), DescribeQueueOpt)

参数说明

type DescribeDocProcessQueuesOptions struct {
QueueIds string `url:"queueIds,omitempty"`
State string `url:"state,omitempty"`
PageNumber int `url:"pageNumber,omitempty"`
PageSize int `url:"pageSize,omitempty"`
}
参数名称
描述
类型
QueueIds
队列 ID,以“,”符号分割字符串
String
State
1. Active 表示队列内的作业会被文档预览服务调度执行 2. Paused 表示队列暂停,作业不再会被文档预览服务调度执行,队列内的所有作业状态维持在暂停状态,已经处于执行中的任务将继续执行,不受影响
String
PageNumber
第几页
int
PageSize
每页个数
int

返回结果说明

type DescribeDocProcessQueuesResult struct {
XMLName xml.Name
RequestId string
TotalCount int
PageNumber int
PageSize int
QueueList []DocProcessQueue
NonExistPIDs []string
}
type DocProcessQueue struct {
QueueId string
Name string
State string
MaxSize int
MaxConcurrent int
UpdateTime string
CreateTime string
NotifyConfig *DocProcessQueueNotifyConfig
}
type DocProcessQueueNotifyConfig struct {
Url string
State string
Type string
Event string
}
参数名称
描述
类型
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

更新文档预览队列

功能说明

UpdateDocProcessQueue 接口用于更新文档预览队列。

方法原型

func (s *CIService) UpdateDocProcessQueue(ctx context.Context, opt *UpdateDocProcessQueueOptions) (*UpdateDocProcessQueueResult, *Response, error)

请求示例

updateQueueOpt := &cos.UpdateDocProcessQueueOptions{
Name: "queue-doc-process-1",
QueueID: "p111a8dd208104ce3b11c78398f658ca8",
State: "Active",
NotifyConfig: &cos.DocProcessQueueNotifyConfig{
State: "Off",
},
}
res, _, err := c.CI.UpdateDocProcessQueue(context.Background(), updateQueueOpt)

参数说明

type UpdateDocProcessQueueOptions struct {
XMLName xml.Name
Name string
QueueID string
State string
NotifyConfig *DocProcessQueueNotifyConfig
}
参数名称
描述
类型
Name
队列名称
String
QueueID
队列 ID
String
State
队列状态
String
NotifyConfig
通知渠道,详情请参见 DocProcessQueue.NotifyConfig
Container

返回结果说明

type UpdateDocProcessQueueResult struct {
XMLName xml.Name
RequestId string
Queue *DocProcessQueue
}
参数名称
描述
类型
RequestId
请求的唯一 ID
Struct
Queue
队列信息,详情请参见 DescribeDocProcessQueuesResult.QueueList
Struct

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈