SubmitProjectExportJob

更新时间:
复制 MD 格式

Submits 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:SubmitProjectExportJob

none

*All Resource

*

None None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

ProjectId

string

No

The ID of the online editing project.

Important Either ProjectId or Timeline must be provided.

*****67ae06542b9b93e0d1c387*****

Timeline

string

No

The timeline of the online editing job. For data structure, see Timeline.

Important Either ProjectId or Timeline must be provided.

{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****4d7cf14dc7b83b0e801c****"},{"MediaId":"****4d7cf14dc7b83b0e801c****"}]}]}

ExportType

string

No

The export type. Valid values:

  • BaseTimeline: exports the timeline.

  • AdobePremierePro: exports an Adobe Premiere Pro project.

BaseTimeline

OutputMediaConfig

string

Yes

The output path for the exported project and generated intermediate files, in JSON format. The export destination only supports OSS. Path fields:

  • Bucket: Required. The OSS bucket name.

  • Prefix: Optional. The path prefix. If not specified, it defaults to the root directory.

  • Width: Optional. The width of the output. The value must be a positive integer. If not provided, the system automatically calculates the value based on the input project or timeline.

  • Height: Optional. The height of the output. The value must be a positive integer. If not provided, the system automatically calculates the value based on the input project or timeline.

{ "Bucket": "example-bucket", "Prefix": "example_prefix", "Width": 1920, "Height": 1080 }

UserData

string

No

The user-defined data in the JSON format.

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

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The ID of the request.

******11-DB8D-4A9A-875B-275798******

JobId

string

The ID of the project export task.

****cdb3e74639973036bc84****

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****cdb3e74639973036bc84****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.