tencent cloud

Cloud Infinite

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Product Overview
Product Strengths
Use Cases
Feature Overview
Regions and Domains
Specifications and Limits
Billing
Billing Overview
Billing Mode
Billable Items
Free Tier
Payment Overdue
Viewing Bill Details
FAQs
Getting Started
Registering and Logging In
Bind Bucket
Uploading and Processing File
Downloading and Deleting Images
Unbinding Buckets
Using CI via COS
Features
Image Processing
Media Processing
Content Moderation
AI Content Recognition
File Processing
Smart Voice
File processing
User Guide
Overview
Bucket Management
Smart Toolbox
Job and Workflow
Data Monitoring
Usage statistics
Use Cases
Copyright Protection Solutions
Image Processing Practices
Working with API Authorization Policies
Workflow Practices
API Documentation
API Overview
Structure
Common Request Headers
Common Response Headers
Activate Vast Service
Image Processing
AI-Based Content Recognition
Smart Audio
Media Processing
Content Moderation
Document Processing
File Processing
Job and Workflow
Cloud Virus Detection
Error Codes
Request Signature
SDK Documentation
SDK Overview
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
Mini Program SDK
Personal Information Protection Policy for SDK
Security and Compliance
Permission ‍Management
FAQs
Basic Settings
Document Processing
Media Processing
Content Recognition
Smart Audio
Agreements
Service Level Agreement
Contact Us
Glossary

Querying File Transcoding Queue

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-12-25 16:23:20

Description

This API is used to query the queue for document transcoding.

Authorization Description

When a sub-account is used, you need to add the ci:DescribeDocProcessQueues permission in the action of the authorization policy. For all supported operation interfaces of Cloud Infinite, see CI action.

Service Activation

To use this feature, you need to bind Bucket in advance and activate the Cloud Infinite service.
To use this feature, you need to activate the document processing service in advance via the console or API.
Note:
After Cloud Infinite is bound, if you manually unbind Cloud Infinite from the Bucket, you will not be able to continue using this feature.

Use Limits

When using this interface, please first confirm the relevant restrictions. For details, see Usage Limits.


Request

Request sample

GET /docqueue?pageNumber=1&pageSize=2 HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

Note:
Authorization: Auth String. For details, see the Request Signature documentation.

Request header

This API only uses common request headers. For details, see Common Request Headers.

Request body

The request body of this request is empty.

Request Parameter

Name
Description
Type
Required
queueIds
queue ID, split by "," symbol
string
No
state
Active indicates that jobs in the Queue will be scheduled for execution by the service for document preview.
Paused indicates that the Queue is paused. Jobs will no longer be scheduled for execution by the service for document preview. All jobs in the Queue will remain in the paused state. Tasks that are already in execution will continue to execute and remain unaffected.
string
No
pageNumber
Page number, defaults to the first page
string
No
pageSize
Number of items per page, defaults to 10
string
No

Response

Response Headers

This API only returns common response headers. For details, see Common Response Headers.

Response Body

The response body is returned as application/xml data.
Response Body 1: When pageNumber and pageSize are specified, the content containing complete data of the node is displayed as follows:
<Response>
<TotalCount>1</TotalCount>
<RequestId>RequestId</RequestId>
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<QueueList>
<QueueId>QueueId</QueueId>
<Name>QueueName</Name>
<State>Active</State>
<NotifyConfig>
<Url>url</Url>
<Event>Event</Event>
<Type/></Type>
<State>Off</State>
</NotifyConfig>
<MaxSize>10000</MaxSize>
<MaxConcurrent>10</MaxConcurrent>
<CreateTime>CreateTime</CreateTime>
<UpdateTime>UpdateTime</UpdateTime>
<BucketId>BucketId</BucketId>
<Category>DocProcess</Category>
</QueueList>
</Response>
The specific data content is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
content of the Response of the Container node:
Node Name (Keyword)
Parent Node
Description
Type
RequestId
Response
unique request ID
String
TotalCount
Response
Total number of queues
Int
PageNumber
Response
current page number, same as the pageNumber in the request.
Int
PageSize
Response
number of items per page, same as the pageSize in the request.
Int
QueueList
Response
queue array
Container
content of the QueueList of the Container node:
Node Name (Keyword)
Parent Node
Description
Type
QueueId
Response.QueueList
Queue ID
String
Name
Response.QueueList
queue name
String
State
Response.QueueList
Current status, Active or Paused
String
NotifyConfig
Response.QueueList
callback configuration
Container
MaxSize
Response.QueueList
maximum length of queue
Int
MaxConcurrent
Response.QueueList
Maximum number of tasks executed in parallel in the current queue
Int
Category
Response.QueueList
queue type
String
UpdateTime
Response.QueueList
Update time
String
CreateTime
Response.QueueList
Creation time
String
BucketId
Response.QueueList
Bucket ID of the Queue
String
content of the NotifyConfig of the Container node:
Node Name (Keyword)
Parent Node
Description
Type
Url
Response.QueueList.NotifyConfig
callback URL
String
State
Response.QueueList.NotifyConfig
Status, On or Off
String
Type
Response.QueueList.NotifyConfig
Callback type, Url
String
Event
Response.QueueList.NotifyConfig
events that trigger the callback
String
ResultFormat
Response.QueueList.NotifyConfig
Callback type, XML or JSON
String
Response Body 2: When queueIds is specified, the content containing complete node data is displayed as follows:
<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<QueueList>
<QueueId>A</QueueId>
<Name></Name>
<State>Active</State>
<NotifyConfig>
<Url></Url>
</NotifyConfig>
</QueueList>
<NonExistPIDs>
<QueueID>B</QueueID>
<QueueID>C</QueueID>
</NonExistPIDs>
</Response>
The specific data content is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
content of the Response of the Container node:
Node Name (Keyword)
Parent Node
Description
Type
RequestId
Response
unique request ID
String
QueueList
Response
Queue array, same as the QueueList described above
Container
NonExistPIDs
Response
non-existing queue ID list
Container
content of the NonExistPIDs of the Container node:
Node Name (Keyword)
Parent Node
Description
Type
QueueID
Response.NonExistPIDs
Queue ID
String

Error Codes

This request operation has no special error messages. For common error messages, see Error Codes.

Usage Examples

Request

GET /docqueue?pageNumber=1&pageSize=2 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
Authorization: Authorization

Response

HTTP/1.1 200 OK
Date: Mon, 27 Jul 2020 07:29:28 GMT
Content-Type: application/xml
Content-Length: 677
Connection: keep-alive
Server: tencent-ci
x-ci-request-id: NWYxZTgyNTdfYzc2OTQzNjRfMzUx****

<?xml version="1.0" encoding="utf-8"?>
<Response>
<TotalCount>1</TotalCount>
<RequestId>NWYxZTgyNTdfYzc2OTQzNjRfMzUx****</RequestId>
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<QueueList>
<QueueId>p2505d57bdf4c4329804b58a6a5fb1572</QueueId>
<Name>queue-doc-process-1</Name>
<State>Active</State>
<NotifyConfig>
<Url/>
<Event/>
<Type/>
<State>Off</State>
</NotifyConfig>
<MaxSize>10000</MaxSize>
<MaxConcurrent>10</MaxConcurrent>
<CreateTime>2020-07-24T22:42:27+0800</CreateTime>
<UpdateTime>2020-07-24T22:42:27+0800</UpdateTime>
<BucketId>examplebucket-1250000000.</BucketId>
<Category>DocProcessing</Category>
</QueueList>
</Response>


도움말 및 지원

문제 해결에 도움이 되었나요?

피드백