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
联系我们
词汇表
文档数据万象API 文档文档处理服务与队列配置更新文档转码队列

更新文档转码队列

PDF
聚焦模式
字号
最后更新时间： 2025-12-25 16:21:31

功能描述

UpdateDocProcessQueue 接口用于更新文档转码队列。

授权说明

通过子账号使用时，需要在 授权策略 的 action 中添加 ci:UpdateDocProcessQueue权限。数据万象支持的所有操作接口请参见 CI action。

服务开通

使用该功能需提前 绑定存储桶，开通数据万象服务。
使用该功能需提前通过 控制台 或 接口 开通文档处理服务。
注意：
数据万象绑定后，如果您手动对存储桶进行数据万象的解绑操作，将无法继续使用该功能。

使用限制

使用该接口时，请先确认相关限制条件。详情请参见 使用限制。


请求

请求示例

PUT /docqueue/<queueId> HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>
说明:
Authorization: Auth String，详情请参见 请求签名 文档。
<queueId>：文件处理队列 ID，可通过 控制台 或 接口 查询。

请求头

此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

请求体

该请求操作的实现需要有以下请求体。
<Request>
    <Name>Queue Name</Name>
    <State></State>
    <NotifyConfig>
        <Type></Type>
        <Url></Url>
        <Event></Event>
    </NotifyConfig>
</Request>
具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Request
无
保存请求的容器
Container
是
Container 类型 Request 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
限制
Name
Request
队列名称
String
是
长度限制100字符
State
Request
队列状态
String
是
1. Active 表示队列内的作业会被文档预览服务调度转码执行
2. Paused 表示队列暂停，作业不再会被文档预览服务调度执行，队列内的所有作业状态维持在已提交状态，已经处于执行中的任务将继续执行，不受影响
NotifyConfig
Request
通知渠道
Container
是
第三方回调 Url
Container 类型 NotifyConfig 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
限制
Url
Request.NotifyConfig
回调配置
String
否
长度限制100字符
Type
Request.NotifyConfig
回调类型，普通回调：Url
String
否
长度限制100字符
Event
Request.NotifyConfig
回调事件，文档预览任务完成
String
否
长度限制100字符
State
Request.NotifyConfig
回调开关，Off，On
String
否
长度限制100字符

响应

响应头

此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
    <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
    <Queue>
        <QueueId></QueueId>
        <Name></Name>
        <State>Active</State>
        <NotifyConfig>
            <Url>mts-topic-1</Url>
            <Type></Type>
            <Event></Event>
        </NotifyConfig>
        <CreateTime></CreateTime>
        <UpdateTime></UpdateTime>
    </Queue>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点 Response 的内容：
节点名称（关键字）
父节点
描述
类型
RequestId
Response
请求的唯一 ID
String
Queue
Response
队列信息，详情请参见 DescribeDocProcessQueues 中的 Response.QueueList
Container

错误码

该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

实际案例

请求

PUT /docqueue/p2505d57bdf4c4329804b58a6a5fb1572 HTTP/1.1
Connection: keep-alive
Accept-Encoding: gzip, deflate
Accept: */*
User-Agent: cos-python-sdk-v5.3.2
Host: examplebucket-1250000000.ci.ap-chongqing.myqcloud.com
Content-Type: application/xml
Content-Length: 279
Authorization: Authorization

<?xml version="1.0" encoding="UTF-8" ?>
<Request>
    <State>Active</State>
    <Name>markjrzhang4</Name>
    <NotifyConfig>
        <Url>http://google.com/</Url>
        <Type>Url</Type>
        <Event>TransCodingFinish</Event>
    </NotifyConfig>
</Request>

响应

HTTP/1.1 200 OK
Date: Mon, 27 Jul 2020 08:22:41 GMT
Content-Type: application/xml
Content-Length: 641
Connection: keep-alive
Server: tencent-ci
x-ci-request-id: NWYxZThlZDBfYzc2OTQzNjRfMzUxYV8x****

<?xml version="1.0" encoding="utf-8"?>
<Response>
    <RequestId>NWYxZThlZDBfYzc2OTQzNjRfMzUxYV8x****</RequestId>
    <Queue>
        <QueueId>p2505d57bdf4c4329804b58a6a5fb1572</QueueId>
        <Name>markjrzhang4</Name>
        <State>Active</State>
        <NotifyConfig>
            <Url>http://example.com/</Url>
            <Event>TransCodingFinish</Event>
            <Type>Url</Type>
            <State>On</State>
        </NotifyConfig>
        <MaxSize>10000</MaxSize>
        <MaxConcurrent>10</MaxConcurrent>
        <CreateTime>2020-07-24T22:42:27+0800</CreateTime>
        <UpdateTime>2020-07-27T16:22:40+0800</UpdateTime>
        <BucketId>test007-1251704708</BucketId>
        <Category>DocProcessing</Category>
     </Queue>
</Response>

上一篇: 查询文档转码队列下一篇: 同步请求接口

帮助和支持

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

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

文档反馈