ListSmartJobs - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries a list of intelligent jobs based on specified parameters.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:ListSmartJobs		All Resources ``	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	long	No	The maximum number of entries to return. Default value: 10. Valid values: 1 to 100.	10
PageNo	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page. Default value: 10. Valid values: 1 to 100.	10
JobType	string	No	The job type. Valid values: ASR: automatic speech recognition(job) job. DynamicChart: dynamic chart job. VideoTranslation: video translation job. TextToSpeech: intelligent audio production job.	ASR
SortBy	string	No	The sorting parameter. By default, the query results are sorted by creation time in descending order. Valid values: CreationTime:Asc: sorted by creation time in ascending order. CreationTime:Desc: sorted by creation time in descending order.	CreationTime:Desc
JobState	string	No	The job state. Valid values: Finished: The job is complete. Failed: The job failed. Executing: The job is in progress. Created: The job is created.	Finished

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	**9262E3DA-07FA-4862-FCBB6BC61D08***
SmartJobList	array<object>	The queried intelligent jobs.
SmartJobList	object	The queried intelligent job.
JobId	string	The job ID.	**20b48fb04483915d4f2cd8ac**
Title	string	The job title.
Description	string	The job description.
UserId	long	The user ID.	1084506228******
JobType	string	The job type. Valid values: ASR: ASR job. DynamicChart: dynamic chart job. TextToSpeech: intelligent audio production job.	ASR
EditingConfig	string	The editing configurations.	{"AudioConfig":{},"InputConfig":""}
UserData	string	The user-defined data.	{"user":"data"}
JobState	string	The job state. Valid values: Finished: The job is complete. Failed: The job failed. Executing: The job is in progress. Created: The job is created.	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.
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

Sample success responses

JSONformat

{
  "RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "SmartJobList": [
    {
      "JobId": "****20b48fb04483915d4f2cd8ac****",
      "Title": "",
      "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": ""
      },
      "OutputConfig": {
        "Bucket": "test-bucket",
        "Object": "test-object"
      }
    }
  ],
  "NextToken": "CBB6BC61D08",
  "MaxResults": "10",
  "TotalCount": "110"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-02-21	The request parameters of the API has changed. The response structure of the API has changed	View Change Details