ListLiveTranscodeJobs - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries a list of live stream transcoding jobs.

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:ListLiveTranscodeJobs		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Type	string	No	The type of the template used by the transcoding job. normal narrow-band audio-only origin	normal
StartMode	integer	No	The start mode of the transcoding job. 0: The transcoding job immediately starts. 1: The transcoding job starts at the scheduled time.	0
Status	integer	No	The state of the job. 0: The job is not started. 1: The job is in progress. 2: The job is stopped.	1
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	20
SortBy	string	No	The sorting order. By default, the query results are sorted by creation time in descending order. Valid values: asc desc	asc
KeyWord	string	No	The search keyword. You can use the job ID or name as the keyword to search for jobs. If you search for jobs by name, fuzzy match is supported.	24ecbb5c-4f98-4194-9400-f17102e27fc5

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
TotalCount	integer	The total number of entries returned.	100
JobList	array<object>	The list of transcoding jobs.
job	object
Name	string	The name of the transcoding job.	mytask
JobId	string	The job ID.	**a046-263c-3560-978a-fb287782**
TemplateType	string	The type of the transcoding template used by the transcoding job.	normal
TemplateId	string	The ID of the transcoding template used by the transcoding job.	**a046-263c-3560-978a-fb287666**
TemplateName	string	The template name.
StartMode	integer	The start mode of the job.	0
Status	integer	The state of the job.	1
StreamInput	object	The information about the input stream.
Type	string	The type of the input stream.	rtmp
InputUrl	string	The URL of the input stream.	rtmp://mydomain/app/stream1
OutputStream	object	The information about the output stream.
StreamInfos	array<object>	The list of stream URLs.
streamInfo	object
Type	string	The type of the output stream protocol. Only the RTMP protocol is supported.	rtmp
OutputUrl	string	The URL of the output stream.	rtmp://mydomain/app/mytranscode1
CreateTime	string	The time when the job was created.	2022-07-20T02:48:58Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "TotalCount": 100,
  "JobList": [
    {
      "Name": "mytask",
      "JobId": "****a046-263c-3560-978a-fb287782****",
      "TemplateType": "normal",
      "TemplateId": "****a046-263c-3560-978a-fb287666****",
      "TemplateName": "",
      "StartMode": 0,
      "Status": 1,
      "StreamInput": {
        "Type": "rtmp",
        "InputUrl": "rtmp://mydomain/app/stream1"
      },
      "OutputStream": {
        "StreamInfos": [
          {
            "Type": "rtmp",
            "OutputUrl": "rtmp://mydomain/app/mytranscode1"
          }
        ]
      },
      "CreateTime": "2022-07-20T02:48:58Z"
    }
  ]
}

Error codes

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