All Products
Search
Document Center

Intelligent Media Services:GetLiveTranscodeJob

Last Updated:Dec 16, 2024

Queries the information about a live stream transcoding job.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:GetLiveTranscodeJob
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The ID of the transcoding job.

****20b48fb04483915d4f2cd8ac****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

******3B-0E1A-586A-AC29-742247******
Jobobject

The information about the transcoding job.

Namestring

The name of the transcoding job.

task1
JobIdstring

The ID of the transcoding job.

****20b48fb04483915d4f2cd8ac****
TemplateTypestring

The type of the template.

normal
TemplateIdstring

The template ID.

b6491d5b3e514b7d895d14b5453ea119
TemplateNamestring

The template name.

basic
StartModeinteger

The start mode of the job.

0
Statusinteger

The state of the job.

  • 0: The job is not started.
  • 1: The job is in progress.
  • 2: The job is stopped.
1
StreamInputobject

The information about the input stream.

Typestring

The type of the input stream.

rtmp
InputUrlstring

The URL of the input stream.

rtmp://mydomain/app/stream1
OutputStreamobject

The information about the output stream.

StreamInfosarray<object>

The information about the output stream.

streamInfoobject
Typestring

The type of the output stream protocol. Only the RTMP protocol is supported.

rtmp
OutputUrlstring

The URL of the output stream.

rtmp://mydomain/app/mytranscode1
CreateTimestring

The time when the job was created.

2022-07-20T02:48:58Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Job": {
    "Name": "task1",
    "JobId": "****20b48fb04483915d4f2cd8ac****",
    "TemplateType": "normal",
    "TemplateId": "b6491d5b3e514b7d895d14b5453ea119",
    "TemplateName": "basic",
    "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

HTTP status codeError codeError message
400Forbidden%s

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