All Products
Search
Document Center

Intelligent Media Services:GetPackageJob

Last Updated:Dec 16, 2024

Queries the information about a packaging 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:GetPackageJob
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The job ID. You can obtain the job ID from the response parameters of the SubmitPackageJob operation.

ab4802364a2e49208c99efab82dfa8e8

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

31E30781-9495-5E2D-A84D-759B0A01E262
PackageJobobject

The information about the packaging job.

JobIdstring

The job ID.

ab4802364a2e49208c99efab82dfa8e8
TriggerSourcestring

The source of the job. Valid values:

  • API
  • WorkFlow
  • Console
API
Namestring

The name of the job.

job-name
Inputsarray<object>

The input of the job.

Inputobject

The input of the job.

Inputobject

The information about the input stream file.

Typestring

The type of the media object. Valid values:

  • OSS: an Object Storage Service (OSS) object.
  • Media: a media asset.
OSS
Mediastring

The media object.

  • If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported.
  • If Type is set to Media, the ID of a media asset is returned.
oss://bucket/path/to/video.mp4
Outputobject

The output of the job.

Typestring

The type of the media object. Valid values:

  • OSS: an OSS object.
  • Media: a media asset.
OSS
Mediastring

The media object.

  • If Type is set to OSS, the URL of an OSS object is returned. Both the OSS and HTTP protocols are supported.
  • If Type is set to Media, the ID of a media asset is returned.
oss://bucket/path/to/video.m3u8
OutputUrlstring

The URL of the output file.

http://bucket.oss-cn-shanghai.aliyuncs.com/output.m3u8
PipelineIdstring

The ID of the MPS queue to which the job was submitted.

36f3fee40aa047c0b067d0fb85edc12b
Priorityinteger

The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority.

6
Statusstring

The state of the job.

Init
Codestring

The error code returned if the job fails.

InvalidParameter
Messagestring

The error message that is returned.

Resource content bad.
SubmitTimestring

The time when the job was submitted. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2022-09-08T11:34:05Z
FinishTimestring

The time when the job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2022-09-08T11:44:05Z
UserDatastring

The user-defined data.

{"param": "value"}
CreateTimestring

The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2022-09-08T11:34:05Z
ModifiedTimestring

The time when the job was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2022-09-08T11:44:05Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
  "PackageJob": {
    "JobId": "ab4802364a2e49208c99efab82dfa8e8",
    "TriggerSource": "API",
    "Name": "job-name",
    "Inputs": [
      {
        "Input": {
          "Type": "OSS",
          "Media": "oss://bucket/path/to/video.mp4"
        }
      }
    ],
    "Output": {
      "Type": "OSS",
      "Media": "oss://bucket/path/to/video.m3u8"
    },
    "OutputUrl": "http://bucket.oss-cn-shanghai.aliyuncs.com/output.m3u8",
    "PipelineId": "36f3fee40aa047c0b067d0fb85edc12b",
    "Priority": 6,
    "Status": "Init",
    "Code": "InvalidParameter",
    "Message": "Resource content bad.",
    "SubmitTime": "2022-09-08T11:34:05Z",
    "FinishTime": "2022-09-08T11:44:05Z",
    "UserData": "{\"param\": \"value\"}",
    "CreateTime": "2022-09-08T11:34:05Z\n",
    "ModifiedTime": "2022-09-08T11:44:05Z\n"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2022-09-20The response structure of the API has changedView Change Details