Use GetEditingProject to query online editing project information - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Queries the information about an online editing project.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	The ID of the online editing project.	**fb2101bf24b2754cb318787dc**
RequestSource	string	No	The ID of the request source. Valid values: - OpenAPI (default): Timeline conversion is not performed. - WebSDK: If you specify this value, the project timeline is automatically converted into the frontend style, and the materials in the timeline are associated with the project to enable preview by using frontend web SDKs.	WebSDK

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	**63E8B7C7-4812-46AD-0FA56029AC86**
Project	object	The information about the online editing project.
ProjectId	string	The ID of the online editing project.	**fb2101bf24b2754cb318787dc**
Title	string	The title of the online editing project.	Sample Title
Timeline	string	The timeline of the online editing project.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"**9b4d7cf14dc7b83b0e801cbe"},{"MediaId":"9b4d7cf14dc7b83b0e801cbe"},{"MediaId":"1656bca4474999c961a6d2a2**"}]}]}
TemplateId	string	The template ID.	**96e8864746a0b6f3**
ClipsParam	string	The material parameter corresponding to the template, in the JSON format. If TemplateId is specified, ClipsParam must also be specified. For more information.	See template usage documentation
Description	string	The description of the online editing project.	Example description
CoverURL	string	The thumbnail URL of the online editing project.	http://aaa.bbb/your-cover.jpg
CreateTime	string	The time when the online editing project was created.	2020-12-20T12:00:00Z
ModifiedTime	string	The time when the online editing project was last modified.	2020-12-20T13:00:00Z
Duration	integer	The total duration of the online editing project.	24.120000
Status	string	The status of the online editing project. Valid values: - Draft - Editing - Producing - Produced - ProduceFailed - Deleted	Editing
CreateSource	string	The method for creating the online editing project. Valid values: - OpenAPI - AliyunConsole - WebSDK - LiveEditingOpenAPI - LiveEditingConsole	OpenAPI
TemplateType	string	The template type of the online editing project. Valid values: - Timeline - VETemplate	Timeline
ModifiedSource	string	The method for editing the online editing project. Valid values: - OpenAPI - AliyunConsole - WebSDK - LiveEditingOpenAPI - LiveEditingConsole	OpenAPI
ProjectType	string	The type of the editing project. Default value: EditingProject. Valid values: - EditingProject: a regular editing project. - LiveEditingProject: a live stream editing project.	EditingProject
BusinessConfig	string	The business configuration of the project. This parameter can be ignored for general editing projects.	{ "OutputMediaConfig" : { "StorageLocation": "test-bucket.oss-cn-shanghai.aliyuncs.com", "Path": "test-path" }, "OutputMediaTarget": "oss-object", "ReservationTime": "2021-06-21T08:05:00Z" }
BusinessStatus	string	The business status of the project. This parameter can be ignored for general editing projects. Valid values: Reserving ReservationCanceled BroadCasting LoadingFailed LiveFinished	Reserving
TimelineConvertStatus	string	The project conversion status. Conversion of an API-style timeline into a frontend-style timeline is an asynchronous process and takes effect only if RequestSource:WebSDK is specified. - Unconverted - Converting - Converted - ConvertFailed	Converted
TimelineConvertErrorMessage	string	The error message returned if the project conversion failed. The error message displays the detailed information about the failure, and is returned only if the value of TimelineConvertStatus is ConvertFailed.	The StorageLocation must be in the same division(apiRegion) as ICE service access point.

Examples

Success response

JSON format

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "Project": {
    "ProjectId": "****fb2101bf24b2754cb318787dc****",
    "Title": "Sampletitle",
    "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****1656bca4474999c961a6d2a2****\"}]}]}",
    "TemplateId": "****96e8864746a0b6f3****",
    "ClipsParam": "See template usage documentation",
    "Description": "Example description",
    "CoverURL": "http://aaa.bbb/your-cover.jpg",
    "CreateTime": "2020-12-20T12:00:00Z",
    "ModifiedTime": "2020-12-20T13:00:00Z",
    "Duration": 24.12,
    "Status": "Editing",
    "CreateSource": "OpenAPI",
    "TemplateType": "Timeline",
    "ModifiedSource": "OpenAPI",
    "ProjectType": "EditingProject",
    "BusinessConfig": "{ \"OutputMediaConfig\" : { \"StorageLocation\": \"test-bucket.oss-cn-shanghai.aliyuncs.com\", \"Path\": \"test-path\" }, \"OutputMediaTarget\": \"oss-object\", \"ReservationTime\": \"2021-06-21T08:05:00Z\" }",
    "BusinessStatus": "Reserving",
    "TimelineConvertStatus": "Converted",
    "TimelineConvertErrorMessage": "The StorageLocation must be in the same division(apiRegion) as ICE service access point."
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter \ is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.