tencent cloud

Querying the File Processing Queue
Download PDF
Last updated:2025-09-11 16:04:20
Querying the File Processing Queue
Last updated: 2025-09-11 16:04:20
Download PDF

Feature Description

This API is used to query the file processing queue.

Authorization Description

When using with a sub-account, the ci:DescribeFileProcessQueues permission is required. For details, see Cloud Infinite action.

Activating a Service

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Bind Bucket.
Use this feature requires enabling the file processing service in advance via the console or API. For details, see Enable File Processing Service.

Use Limits

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


Request

Request sample

GET /file_queue 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 Request Signature document.

Request header

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

Request body

The request does not have a request body.

Request parameters

Parameter Name (Keyword)
Description
Type
Required or Not
queueIds
queue ID, split by "," symbol
String
No
state
Active means jobs in the queue will be scheduled for execution
Paused means the queue is paused, jobs will no longer be scheduled for execution, all jobs in the queue remain in a paused state, and executing tasks are unaffected
String
No
pageNumber
Which page, default value 1.
String
No
pageSize
Number of items per page, default value 10.
String
No

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml data. When specifying pageNumber and pageSize, the content of the complete node data is shown as follows:
<Response>
    <RequestId>NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <QueueList>
        <QueueId>p4a17eeea29334bf499b7e20e2fbfd99d</QueueId>
        <Name>My-Queue-file</Name>
        <State>Active</State>
        <NotifyConfig>
            <Url>http://callback.demo.com</Url>
            <Event>TaskFinish,WorkflowFinish</Event>
            <Type>Url</Type>
            <State>On</State>
            <ResultFormat>JSON</ResultFormat>
        </NotifyConfig>
        <MaxSize>10000</MaxSize>
        <MaxConcurrent>10</MaxConcurrent>
        <UpdateTime>2022-08-09T16:23:11+0800</UpdateTime>
        <CreateTime>2022-08-09T16:23:11+0800</CreateTime>
        <Category>FileProcess</Category>
    </QueueList>
</Response>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node Response content:
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 array
NonExistPIDs
Response
non-existing queue ID list
String array
Container node QueueList content:
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
queue maximum length
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
Container node NotifyConfig content:
Node Name (Keyword)
Parent Node
Description
Type
Url
Response.QueueList.NotifyConfig
callback URL
String
State
Response.QueueList.NotifyConfig
switch state
String
Type
Response.QueueList.NotifyConfig
callback type
String
Event
Response.QueueList.NotifyConfig
callback event
String
ResultFormat
Response.QueueList.NotifyConfig
callback type
String
MqMode
Response.QueueList.NotifyConfig
TDMQ usage mode
String
MqRegion
Response.QueueList.NotifyConfig
TDMQ belonging to park
String
MqName
Response.QueueList.NotifyConfig
TDMQ topic name
String

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Request

GET /file_queue?queueIds=p4a17eeea29334bf499b7e20e2fbfd99d,A,B HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************
Host: test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 0
Content-Type: application/xml

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 09 Aug 2022 16:23:12 GMT
Server: tencent-ci
x-ci-request-id: NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85

<Response>
    <RequestId>NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85</RequestId>
    <QueueList>
        <QueueId>p4a17eeea29334bf499b7e20e2fbfd99d</QueueId>
        <Name>My-Queue-file</Name>
        <State>Active</State>
        <NotifyConfig>
            <Url>http://callback.demo.com</Url>
            <Event>TaskFinish,WorkflowFinish</Event>
            <Type>Url</Type>
            <State>On</State>
            <ResultFormat>JSON</ResultFormat>
        </NotifyConfig>
        <MaxSize>10000</MaxSize>
        <MaxConcurrent>10</MaxConcurrent>
        <UpdateTime>2022-08-09T16:23:11+0800</UpdateTime>
        <CreateTime>2022-08-09T16:23:11+0800</CreateTime>
        <Category>FileProcess</Category>
    </QueueList>
    <NonExistPIDs>A</NonExistPIDs>
    <NonExistPIDs>B</NonExistPIDs>
</Response>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback