This API (UpdateDocProcessQueue
) is used to update a file transcoding queue.
PUT /docqueue/p8eb46b8cc1a94bc09512d16c5c4f4d3a HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
<body>
Note:
- Authorization: Auth String (for more information, see Request Signature).
- When this feature is used by a sub-account, relevant permissions must be granted.
This API only uses common request headers. For more information, see Common Request Headers.
This request requires the following request body:
<Request>
<Name>Queue Name</Name>
<QueueID></QueueID>
<State></State>
<NotifyConfig>
<Type></Type>
<Url></Url>
<Event></Event>
</NotifyConfig>
</Request>
The nodes are described as follows:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
Request | None | Request container | Container | Yes |
Request
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required | Constraints |
---|---|---|---|---|---|
Name | Request | Queue name | String | Yes | Length limit: 100 characters |
QueueID | Request | Queue ID | String | Yes | None |
State | Request | Queue status | String | Yes |
1. Active: Jobs in the queue will be scheduled and executed by the file preview service. 2. Paused: The queue is paused, and jobs in it will no longer be scheduled and executed. All jobs in the queue will remain in the `Submitted` status, while jobs being executed will continue without being affected. |
NotifyConfig | Request | Notification channel | Container | Yes | Third-party callback URL |
NotifyConfig
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type | Required | Constraints |
---|---|---|---|---|---|
Url | Request.NotifyConfig | Callback configuration | String | No | Length limit: 100 characters |
Type | Request.NotifyConfig | Callback type. General callback: Url | String | No | Length limit: 100 characters |
Event | Request.NotifyConfig | Callback event: The file preview job is completed. | String | No | Length limit: 100 characters |
State | Request.NotifyConfig | Callback switch: `Off` or `On` | String | No | Length limit: 100 characters |
This API only returns common response headers. For more information, see Common Response Headers.
The response body returns application/xml data. The following contains all the nodes:
<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>
The nodes are as described below:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Response | None | Result storage container | Container |
Response
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
RequestId | Response | Unique ID of the request | String |
Queue | Response | Queue information. For more information, see Response.QueueList in DescribeDocProcessQueues. |
Container |
There are no special error messages for this request. For common error messages, see Error Codes.
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>
<QueueId>p2505d57bdf4c4329804b58a6a5fb1572</QueueId>
<State>Active</State>
<Name>markjrzhang4</Name>
<NotifyConfig>
<Url>http://google.com/</Url>
<State>On</State>
<Type>Url</Type>
<Event>TransCodingFinish</Event>
</NotifyConfig>
</Request>[!http]
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>
Apakah halaman ini membantu?