tencent cloud

Querying Image Processing (Async) Queue
Download PDF
Last updated: 2025-09-08 16:56:49
Querying Image Processing (Async) Queue
Last updated: 2025-09-08 16:56:49
Download PDF

Feature Description

This API is used to query the Image Processing (async) queue.

Authorization Description

When using a sub-account, you need to add the ci:DescribePicProcessQueues permission to the action in the authorization policy. For all supported operation APIs of Cloud Infinite (CI), see CI action.

Service Activation

To use this feature, you need to bind a bucket and enable Cloud Infinite service in advance.
To use this feature, enable the image async processing service in advance via the console or API.
Note:
Note: After binding Cloud Infinite (CI), if you manually perform unbind on the bucket, you will not be able to continue using this feature.

Use Limits

When using this API, please confirm the related use limits. For details, see Use Limits.


Request

Request sample

GET /picqueue?queueIds=<queueId>&state=<state>&pageNumber=<pageNumber>&pageSize=<pageSize> 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 Signature Request 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: Indicates that jobs in the queue will be scheduled for execution.
Paused: Indicates the queue is suspended, jobs will no longer be scheduled for execution, all jobs in the queue remain in paused state, and executing tasks are not affected.
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. When specifying pageNumber and pageSize, an example including the complete node data is shown below:
<Response>
    <RequestId>NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <QueueList>
        <QueueId>p4a17eeea29334bf499b7e20e2fbfd99d</QueueId>
        <Name>My-Queue-pic</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>
        <BucketId>example-130000000</BucketId>
        <Category>PicProcessing</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, default value is 1000
Int
MaxConcurrent
Response.QueueList
Maximum number of tasks executed in parallel in the current queue, default value is 10
Int
Category
Response.QueueList
queue type
String
UpdateTime
Response.QueueList
Update time
String
CreateTime
Response.QueueList
Creation time
String
BucketId
Response.QueueList
Queue ID of the bucket it belongs to
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 Code

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

Practical Case

Request

GET /picqueue?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-pic</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>PicProcessing</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