Queries a list of intelligent jobs based on specified parameters.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ice:ListSmartJobs |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| NextToken |
string |
No |
The pagination token that is used in the next request to retrieve a new page of results. |
****73f33c91-d59383e8280b**** |
| MaxResults |
integer |
No |
The maximum number of entries to return. Default value: 10. Valid values: 1 to 100. |
10 |
| PageNo |
integer |
No |
The page number. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Default value: 10. Valid values: 1 to 100. |
10 |
| JobType |
string |
No |
The job type. Valid values:
Valid values:
|
ASR |
| SortBy |
string |
No |
The sorting parameter. By default, the query results are sorted by creation time in descending order. Valid values:
Valid values:
|
CreationTime:Desc |
| JobState |
string |
No |
The job state. Valid values:
Valid values:
|
Finished |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
****9262E3DA-07FA-4862-FCBB6BC61D08***** |
| SmartJobList |
array<object> |
The queried intelligent jobs. |
|
|
array<object> |
The queried intelligent job. |
||
| JobId |
string |
The job ID. |
****20b48fb04483915d4f2cd8ac**** |
| Title |
string |
The job title. |
Test Title |
| Description |
string |
The job description. |
Test Description |
| UserId |
integer |
The user ID. |
1084506228****** |
| JobType |
string |
The job type. Valid values:
Valid values:
|
ASR |
| EditingConfig |
string |
The editing configurations. |
{"AudioConfig":{},"InputConfig":""} |
| UserData |
string |
The user-defined data. |
{"user":"data"} |
| JobState |
string |
The job state. Valid values:
Valid values:
|
Finished |
| CreateTime |
string |
The time when the job was created. |
2020-12-26T04:11:10Z |
| ModifiedTime |
string |
The time when the job was last modified. |
2020-12-26T04:11:10Z |
| InputConfig |
object |
The input configurations. |
|
| InputFile |
string |
The information about the input file. |
oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 |
| Keyword |
string |
The keyword information. |
Test Keywords |
| OutputConfig |
object |
The output configurations. |
|
| Bucket |
string |
The Object Storage Service (OSS) bucket. |
test-bucket |
| Object |
string |
The OSS object. |
test-object |
| NextToken |
string |
A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists. |
CBB6BC61D08 |
| MaxResults |
string |
The maximum number of entries returned on a single page. The value is set to the maximum number of entries returned on each page except for the last page. Valid example: 10,10,5. Invalid example: 10,5,10. |
10 |
| TotalCount |
string |
Optional. The total number of entries returned. By default, this parameter is not returned. |
110 |
Examples
Success response
JSON format
{
"RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
"SmartJobList": [
{
"JobId": "****20b48fb04483915d4f2cd8ac****",
"Title": "Test Title",
"Description": "Test Description",
"UserId": 0,
"JobType": "ASR",
"EditingConfig": "{\"AudioConfig\":{},\"InputConfig\":\"\"}",
"UserData": "{\"user\":\"data\"}",
"JobState": "Finished",
"CreateTime": "2020-12-26T04:11:10Z",
"ModifiedTime": "2020-12-26T04:11:10Z",
"InputConfig": {
"InputFile": "oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4",
"Keyword": "Test Keywords"
},
"OutputConfig": {
"Bucket": "test-bucket",
"Object": "test-object"
}
}
],
"NextToken": "CBB6BC61D08",
"MaxResults": "10",
"TotalCount": "110"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.