Feature Description
This API is used to update the queue for file processing.
Authorization Description
When using with a sub-account, you need to grant the ci:UpdateFileProcessQueue permission. 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 Limits
When using this API, please first confirm the relevant restrictions. For details, see Usage Limits. Request
Request sample
PUT /file_queue/<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>
Request header
Request body
The implementation of this request operation requires the following request body.
<Request>
<Name>My-Queue-file</Name>
<State>Active</State>
<NotifyConfig>
<State>On</State>
<Url>http://callback.demo.com</Url>
<Type>Url</Type>
<Event>TaskFinish,WorkflowFinish</Event>
<ResultFormat>JSON</ResultFormat>
</NotifyConfig>
</Request>
The data are as follows:
|
Request | None. | Container for saving results | Container | Yes | None. | None. |
Container node Request content:
|
Name | Request | Queue name, supports only Chinese characters, English letters, digits, _, -, and *, with a length not exceeding 128. | String | None. | Yes |
State | Request | 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 maintain a paused status, and executing tasks are unaffected | String | None. | Yes |
NotifyConfig | Request | Callback configuration | Container | None. | Yes |
The content of the NotifyConfig of the Container node
|
State | Request.NotifyConfig | Callback switch Off On | String | Off | No |
Event | Request.NotifyConfig | Callback event TaskFinish: Task complete WorkflowFinish: Workflow completion | String | None. | When State=On, it is required. |
ResultFormat | Request.NotifyConfig | callback format XML JSON | String | XML | No |
Type | Request.NotifyConfig | callback type Url TDMQ | String | None. | When State=On, it is required. |
Url | Request.NotifyConfig | Callback address cannot be a private network address. | String | None. | When State=On and Type=Url, it is required. |
MqMode | Request.NotifyConfig | TDMQ usage mode Topic: Topic subscription Queue: Queue service | String | None. | When State=On and Type=TDMQ, it is required. |
MqRegion | Request.NotifyConfig | The park where TDMQ belongs. Currently supports parks: sh (Shanghai), bj (Beijing), gz (Guangzhou), cd (Chengdu), hk (Hong Kong (China)). | String | None. | When State=On and Type=TDMQ, it is required. |
MqName | Request.NotifyConfig | TDMQ Topic Name | String | None. | When State=On and Type=TDMQ, it is required. |
Response
Response Headers
Response Body
The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
<RequestId>NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85</RequestId>
<Queue>
<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>
<MqMode/>
<MqName/>
<MqRegion/>
</NotifyConfig>
<MaxSize>10000</MaxSize>
<MaxConcurrent>10</MaxConcurrent>
<Category>FileProcess</Category>
<UpdateTime>2022-08-09T16:23:11+0800</UpdateTime>
<CreateTime>2022-08-09T16:13:05+0800</CreateTime>
</Queue>
</Response>
The data are as follows:
|
Response | None. | Container for saving results | Container |
Container node Response content:
|
RequestId | Response | unique request ID | String |
Queue | Response | queue information | Container |
Container node Queue content:
|
QueueId | Response.Queue | Queue ID | String |
Name | Response.Queue | queue name | String |
State | Response.Queue | current status, Active or Paused | String |
NotifyConfig | Response.Queue | callback configuration | Container |
MaxSize | Response.Queue | queue maximum length | Int |
MaxConcurrent | Response.Queue | current maximum number of parallel executed tasks in the queue | Int |
Category | Response.Queue | queue type | String |
UpdateTime | Response.Queue | Update time | String |
CreateTime | Response.Queue | Creation time | String |
Error Codes
This request returns common error responses and error codes. For more information, see Error Codes. Examples
Request
PUT /file_queue/p4a17eeea29334bf499b7e20e2fbfd99d 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: 162
Content-Type: application/xml
<Request>
<Name>My-Queue-file</Name>
<State>Active</State>
<NotifyConfig>
<State>On</State>
<Url>http://callback.demo.com</Url>
<Type>Url</Type>
<Event>TaskFinish,WorkflowFinish</Event>
<ResultFormat>JSON</ResultFormat>
</NotifyConfig>
</Request>
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>
<Queue>
<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>
<MqMode/>
<MqName/>
<MqRegion/>
</NotifyConfig>
<MaxSize>10000</MaxSize>
<MaxConcurrent>10</MaxConcurrent>
<Category>FileProcess</Category>
<UpdateTime>2022-08-09T16:23:11+0800</UpdateTime>
<CreateTime>2022-08-09T16:13:05+0800</CreateTime>
</Queue>
</Response>