ListSmartJobs

Queries intelligent jobs that match the specified filter conditions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:ListSmartJobs

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The token for the next 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: ASR: automatic speech recognition job. DynamicChart: dynamic chart job. VideoTranslation: video translation job. TextToSpeech: intelligent audio production job. Valid values: ASR : DynamicChart : VideoTranslation : TextToSpeech :	ASR
SortBy	string	No	The sorting parameter. Default: creation time in descending order. Valid values: CreationTime:Asc: ascending by creation time. CreationTime:Desc: descending by creation time. Valid values: CreationTime:Asc : CreationTime:Desc :	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. Valid values: Finished : Failed : Executing : Created :	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: ASR: ASR job. DynamicChart: dynamic chart job. TextToSpeech: intelligent audio production job. Valid values: ASR : DynamicChart : TextToSpeech :	ASR
EditingConfig	string	The editing configuration.	{"AudioConfig":{},"InputConfig":""}
UserData	string	Custom user 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. Valid values: Finished : Failed : Executing : Created :	Finished
CreateTime	string	The job creation time.	2020-12-26T04:11:10Z
ModifiedTime	string	The last modification time.	2020-12-26T04:11:10Z
InputConfig	object	The input configuration.
InputFile	string	The input file path.	oss://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4
Keyword	string	The keyword.	Test keyword
OutputConfig	object	The output configuration.
Bucket	string	The OSS bucket.	test-bucket
Object	string	The OSS object.	test-object
NextToken	string	A pagination token. If empty, no next page exists. Use this token to retrieve the next page of results.	CBB6BC61D08
MaxResults	string	The maximum number of entries per page. All pages except the last return the same count. Valid example: 10, 10, 5. Invalid example: 10, 5, 10.	10
TotalCount	string	The total number of entries. Not returned by default.	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 keyword"
      },
      "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.