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: VoiceSeparate | 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 |
JobsDetail
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Code | Response.JobsDetail | Error code, which is meaningful only if State is Failed |
String |
Message | Response.JobsDetail | Error description, which is meaningful only if State is Failed |
String |
JobId | Response.JobsDetail | Task ID | String |
Tag | Response.JobsDetail | Task type: VoiceSeparate | String |
State | Response.JobsDetail | Task status. Valid values: Submitted , Running , Success , Failed , Pause , Cancel |
String |
CreationTime | Response.JobsDetail | Task creation time | String |
StartTime | Response.JobsDetail | Task start time | String |
EndTime | Response.JobsDetail | Task end time | String |
QueueId | Response.JobsDetail | ID of the queue where the task is in | String |
Input | Response.JobsDetail | Input resource address of the task | Container |
Operation | Response.JobsDetail | Task rule | Container |
Operation
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
TemplateId | Response.JobsDetail.Operation | Task template ID | String |
Output | Response.JobsDetail.Operation | File output address | Container |
VoiceSeparate | Response.JobsDetail.Operation | Transcoding template parameter | Container |
VoiceSeparate
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
AudioMode | Response.JobsDetail.Operation.VoiceSeparate | Same as Request.AudioMode in the voice separation template creation API CreateMediaTemplate . |
Container |
AudioConfig | Response.JobsDetail.Operation.VoiceSeparate | Same as Request.AudioConfig in the voice separation template creation API CreateMediaTemplate . |
Container |
Output
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Region | Response.JobsDetail.Operation.Output | Bucket region | String |
Bucket | Response.JobsDetail.Operation.Output | Result storage bucket | String |
Object | Response.JobsDetail.Operation.Output | Background audio result file name. This node and AuObject cannot be empty at the same time. |
String |
AuObject | Response.JobsDetail.Operation.AuObject | Voice result file name. This node and Object cannot be empty at the same time. |
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=VoiceSeparate 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>VoiceSeparate<Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Output>
<Region>ap-beijing</Region>
<Bucket>abc-1250000000</Bucket>
<Object>test-trans.mp3</Object>
<AuObject></AuObject>
</Output>
</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>VoiceSeparate<Tag>
<Input>
<Object>test.mp4</Object>
</Input>
<Operation>
<VoiceSeparate>
<AudioMode>IsAudio</AudioMode>
<AudioConfig>
<Codec>mp3</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>12</Bitrate>
<Channels>2</Channels>
</AudioConfig>
</VoiceSeparate>
<Output>
<Region>ap-beijing</Region>
<Bucket>abc-1250000000</Bucket>
<Object>test-trans.mp3</Object>
<AuObject></AuObject>
</Output>
</Operation>
</JobsDetail>
</Response>
Was this page helpful?