The API (DescribeMediaJobs
) is used to pull jobs 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, see Request Signature).
This API only uses common request headers. For more information, see Common Request Headers.
This request does not have a request body.
The nodes are as described below:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
queueId | None | ID of the queue from which jobs are pulled | String | Yes |
tag | None | Job type: Tts | String | Yes |
orderByTime | None | Desc (default) or Asc |
String | No |
nextToken | None | Context token for pagination | String | No |
size | None | Maximum number of jobs that can be pulled. The default value is 10. The maximum value is 100. | Integer | No |
states | None | Status of the jobs to pull. If you enter multiple job statuses, 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 job pulling in the format of %Y-%m-%dT%H:%m:%S%z . |
String | No |
endCreationTime | None | End time of the time range for job pulling in the format of %Y-%m-%dT%H:%m:%S%z . |
String | No |
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>
<JobsDetail>
</JobsDetail>
<NextToken></NextToken>
</Response>
The nodes are as described below:
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 | Job details. Same as Response.JobsDetail in CreateMediaJobs . |
Container |
NextToken | Response | Context token for pagination | String |
There are no special error messages for this request. For common error messages, see Error Codes.
GET /jobs?queueId=aaaaaaaaaaa&tag=Tts 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: examplebucket-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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<JobsDetail>
<Code>Success</Code>
<Message>Success</Message>
<JobId>jabcxxxxfeipplsdfwe</JobId>
<State>Submitted</State>
<CreationTime>2019-07-07T12:12:12+0800</CreationTime>
<StartTime></StartTime>
<EndTime></EndTime>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<Tag>Tts<Tag>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Output>
<Region>ap-chongqing</Region>
<Bucket>test-123456789</Bucket>
<Object>demo.wav</Object>
</Output>
<TtsConfig>
<Input>Abed, I see a silver light. I wonder if it's frost around.</Input>
<InputType>Text</InputType>
</TtsConfig>
</Operation>
</JobsDetail>
<JobsDetail>
<Code>Success</Code>
<Message>Success</Message>
<JobId>jabcxxxxfeipplsdfwe</JobId>
<State>Submitted</State>
<CreationTime>2019-07-07T12:12:12+0800</CreationTime>
<StartTime></StartTime>
<EndTime></EndTime>
<QueueId>p893bcda225bf4945a378da6662e81a89</QueueId>
<Tag>Tts<Tag>
<Operation>
<TtsTpl>
<Codec>wav</Codec>
<Mode>Asyc</Mode>
<Speed>100</Speed>
<VoiceType>ruxue</VoiceType>
<Volume>3</Volume>
</TtsTpl>
<Output>
<Region>ap-chongqing</Region>
<Bucket>test-123456789</Bucket>
<Object>demo.wav</Object>
</Output>
<TtsConfig>
<Input>Abed, I see a silver light. I wonder if it's frost around.</Input>
<InputType>Text</InputType>
</TtsConfig>
</Operation>
</JobsDetail>
</Response>
Apakah halaman ini membantu?