ListPackageJobs - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries a list of packaging 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:ListPackageJobs		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
StartOfCreateTime	string	No	The beginning of the time range during which the jobs to be queried were created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-07-01T00:00:00Z
EndOfCreateTime	string	No	The end of the time range during which the jobs to be queried were created. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-07-15T00:00:00Z
JobId	string	No	The job ID.	7b38a5d86f1e47838927b6e7ccb11cbe
Status	string	No	The state of the job. Init: The job is submitted. Success: The job is successful. Fail: The job failed.	Success
OrderBy	string	No	The order that you use to sort the query results. Valid values: CreateTimeDesc: sorts the jobs by creation time in descending order. CreateTimeAsc: sorts the jobs by creation time in ascending order.	CreateTimeDesc
PageSize	integer	No	The number of entries per page. Valid values: 0 to 100. Default value: 20.	10
NextPageToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.	ab4802364a2e49208c99efab82dfa8e8

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	31E30781-9495-5E2D-A84D-759B0A01E262
PackageJobList	object	The list of packaging jobs.
PackageJobs	array<object>	The list of packaging jobs.
PackageJob	object	The packaging job.
JobId	string	The job ID.	7b38a5d86f1e47838927b6e7ccb11cbe
TriggerSource	string	The source of the job. Valid values: API WorkFlow Console	API
Name	string	The name of the job.	job-name
Inputs	array<object>	The input of the job.
Input	object	The input of the job.
Input	object	The information about the input stream file.
Type	string	The type of the media object. Valid values: OSS: an Object Storage Service (OSS) object. Media: a media asset.	OSS
Media	string	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, set this parameter to the ID of a media asset.	oss://bucket/path/to/video.mp4
Output	object	The output of the job.
Type	string	The type of the media object. Valid values: OSS: an OSS object. Media: a media asset.	OSS
Media	string	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, set this parameter to the ID of a media asset.	oss://bucket/path/to/video.mp4
PipelineId	string	The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.	5b40833e4c3e4d4e95a866abb9a42510
Priority	integer	The priority of the job. Valid values: 1 to 10. The greater the value, the higher the priority. Default value: 6.	6
Status	string	The state of the job.	Success
Code	string	The error code returned if the job fails.	InvalidParameter
Message	string	The error message that is returned.	Resource content bad.
SubmitTime	string	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-07-07T14:00:32Z
FinishTime	string	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-07-07T15:00:32Z
UserData	string	The user-defined data.	{"param": "value"}
CreateTime	string	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-07-07T14:00:32Z
ModifiedTime	string	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-07-07T15:00:32Z
NextPageToken	string	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. The token of the next page is returned after you call this operation for the first time.	019daf5780f74831b0e1a767c9f1c178

Examples

Sample success responses

JSONformat

{
  "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
  "PackageJobList": {
    "PackageJobs": [
      {
        "JobId": "7b38a5d86f1e47838927b6e7ccb11cbe",
        "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.mp4"
        },
        "PipelineId": "5b40833e4c3e4d4e95a866abb9a42510",
        "Priority": 6,
        "Status": "Success",
        "Code": "InvalidParameter",
        "Message": "Resource content bad. ",
        "SubmitTime": "2022-07-07T14:00:32Z",
        "FinishTime": "2022-07-07T15:00:32Z",
        "UserData": "{\"param\": \"value\"}",
        "CreateTime": "2022-07-07T14:00:32Z",
        "ModifiedTime": "2022-07-07T15:00:32Z"
      }
    ],
    "NextPageToken": "019daf5780f74831b0e1a767c9f1c178"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-09-20	The response structure of the API has changed	View Change Details