The API (DescribeMediaJobs
) is used to pull tasks that meet specified conditions.
GET /jobs?size=&states=&queueId=&startCreationTime=&endCreationTime= HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Note:Authorization: Auth String (For more information, please see Request Signature.)
This API only uses Common Request Headers.
This request does not have a request body.
The nodes are described as follows:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
QueueId | None | ID of the queue from which tasks are pulled | String | Yes |
Tag | None | Task type: Animation | String | Yes |
OrderByTime | None | Desc (default) or Asc |
String | No |
NextToken | None | Context token for pagination | String | No |
Size | None | Maximum number of tasks pulled. The default value is 10. The maximum value is 100. | Integer | No |
States | None | Status of the tasks to pull. If you enter multiple task states, separate them with commas (,). Valid values: All (default), Submitted , Running , Success , Failed , Pause , Cancel |
String | No |
StartCreationTime | None | Start time of the time range for task pulling. Format: %Y-%m-%dT%H:%m:%S%z |
String | No |
EndCreationTime | None | End time of the time range for task pulling. Format: %Y-%m-%dT%H:%m:%S%z |
String | No |
This API only returns Common Response Headers.
The response body returns application/xml data. The following contains all the nodes:
<Response>
<JobsDetail>
</JobsDetail>
<NextToken></NextToken>
</Response>
The nodes are described as follows:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Response | None | Response container | Container |
Response
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
JobsDetail | Response | Task details. Same as Response.JobsDetail in CreateMediaJobs . |
Container |
NextToken | Response | Context token for pagination | String |
No special error message will be returned for this request. For the common error messages, please see Error Codes.
GET /jobs?queueId=aaaaaaaaaaa&tag=Animation HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host:bucket-1250000000.ci.ap-beijing.myqcloud.com
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 666
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzh****=
<Response>
<JobsDetail>
<Code>Success</Code>
<Message>Success</Message>
<JobId>je8f65004eb8511eaaed4f377124a303c</JobId>
<State>Submitted</State>
<CreationTime>2019-07-07T12:12:12+0800</CreationTime>
<EndTime>2019-07-07T12:12:12+0800</EndTime>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<Tag>Animation</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Output>
<Region>ap-beijing</Region>
<Bucket>abc-1250000000</Bucket>
<Object>test-trans.gif</Object>
</Output>
</Operation>
</JobsDetail>
<JobsDetail>
<Code>Success</Code>
<Message>Success</Message>
<JobId>je8f65004eb8511eaaed4f377124a303d</JobId>
<State>Submitted</State>
<CreationTime>2019-07-07T12:12:12+0800</CreationTime>
<EndTime>2019-07-07T12:12:12+0800</EndTime>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<Tag>Animation</Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Output>
<Region>ap-beijing</Region>
<Bucket>abc-1250000000</Bucket>
<Object>test-trans.gif</Object>
</Output>
</Operation>
</JobsDetail>
</Response>
Was this page helpful?