GetProjectExportJob

更新时间:
复制 MD 格式

Gets information about a project export task.

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

none

*All Resource

*

None None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

JobId

string

Yes

The ID of the project export task.

****cdb3e74639973036bc84****

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The ID of the request.

****2876-6263-4B75-8F2C-CD0F7FCF****

ProjectExportJob

object

The project export task.

JobId

string

The ID of the project export task.

****cdb3e74639973036bc84****

ProjectId

string

The ID of the online editing project.

****fddd7748b58bf1d47e95****

ExportType

string

The export type. Valid values:

  • BaseTimeline: exports the timeline.

  • AdobePremierePro: exports an Adobe Premiere Pro project.

BaseTimeline

Status

string

The status of the project export task. Valid values:

  • Init: Initializing

  • Processing

  • Success

  • Failed

Success

Code

string

The error code for the failed export task.

Important Use the error code for troubleshooting.

InvalidParameter

Message

string

The error message for the failed export task.

Important Use the error message for troubleshooting.

The specified parameter is not valid.

ExportResult

object

The exported data.

Timeline

string

The timeline of the online editing job. This field is returned when ExportType is BaseTimeline. For data structure, see Timeline.

{"VideoTracks":[{"VideoTrackClips":[{"Type":"Video","MediaId":"****4d7cf14dc7b83b0e801c****","MediaURL":"https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4","TimelineIn":0.0,"TimelineOut":5.0,"In":0.0,"Out":5.0,"Speed":1.0,"Duration":5.0,"VirginDuration":13.334,"Height":1.0,"Width":1.0,"X":0.0,"Y":0.0}]}]}

ProjectUrl

string

The URL of the exported project, which is typically a signed OSS URL. This field is returned when ExportType is AdobePremierePro.

http://example-bucket.oss-cn-shanghai.aliyuncs.com/example_prefix/exported_project_1e8c39a502c3436c84f88290cd713bf3.zip?Expires=1750331685&....

UserData

string

The user-defined data in the JSON format.

{"NotifyAddress":"http://xx.xx.xxx","Key":"Valuexxx"}

Examples

Success response

JSON format

{
  "RequestId": "****2876-6263-4B75-8F2C-CD0F7FCF****",
  "ProjectExportJob": {
    "JobId": "****cdb3e74639973036bc84****\n",
    "ProjectId": "****fddd7748b58bf1d47e95****\n",
    "ExportType": "BaseTimeline",
    "Status": "Success",
    "Code": "InvalidParameter",
    "Message": "The specified parameter is not valid.",
    "ExportResult": {
      "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"Type\":\"Video\",\"MediaId\":\"****4d7cf14dc7b83b0e801c****\",\"MediaURL\":\"https://test-bucket.oss-cn-shanghai.aliyuncs.com/test.mp4\",\"TimelineIn\":0.0,\"TimelineOut\":5.0,\"In\":0.0,\"Out\":5.0,\"Speed\":1.0,\"Duration\":5.0,\"VirginDuration\":13.334,\"Height\":1.0,\"Width\":1.0,\"X\":0.0,\"Y\":0.0}]}]}",
      "ProjectUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/example_prefix/exported_project_1e8c39a502c3436c84f88290cd713bf3.zip?Expires=1750331685&...."
    },
    "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\",\"Key\":\"Valuexxx\"}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.