ListPackageJobs-阿里云帮助中心

Queries packaging jobs.

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:ListPackageJobs

*All Resource

*

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.	7b38a5d86f1e47838927b6e7ccb1****
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.	ab4802364a2e49208c99efab82df****

Response elements

Element	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.
	array<object>	The packaging job.
JobId	string	The job ID.	7b38a5d86f1e47838927b6e7ccb1****
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.
	array<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.	5b40833e4c3e4d4e95a866abb9a4****
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.	019daf5780f74831b0e1a767c9f1****

Examples

Success response

JSON format

{
  "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
  "PackageJobList": {
    "PackageJobs": [
      {
        "JobId": "7b38a5d86f1e47838927b6e7ccb1****",
        "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": "5b40833e4c3e4d4e95a866abb9a4****",
        "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": "019daf5780f74831b0e1a767c9f1****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.