All Products
Search
Document Center

Intelligent Media Services:GetEditingProject

Last Updated:Dec 16, 2024

Queries the information about an online editing project.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:GetEditingProject
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdstringYes

The ID of the online editing project.

****fb2101bf24b2754cb318787dc****
RequestSourcestringNo

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 parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

****63E8B7C7-4812-46AD-0FA56029AC86****
Projectobject

The information about the online editing project.

ProjectIdstring

The ID of the online editing project.

****fb2101bf24b2754cb318787dc****
Titlestring

The title of the online editing project.

Timelinestring

The timeline of the online editing project.

{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****9b4d7cf14dc7b83b0e801cbe****"},{"MediaId":"****1656bca4474999c961a6d2a2****"}]}]}
TemplateIdstring

The template ID.

****96e8864746a0b6f3****
ClipsParamstring

The material parameter corresponding to the template, in the JSON format. If TemplateId is specified, ClipsParam must also be specified. For more information.

Descriptionstring

The description of the online editing project.

CoverURLstring

The thumbnail URL of the online editing project.

oss://example-bucket/example.jpg
CreateTimestring

The time when the online editing project was created.

2020-12-20T12:00:00Z
ModifiedTimestring

The time when the online editing project was last modified.

2020-12-20T13:00:00Z
Durationlong

The total duration of the online editing project.

24.120000
Statusstring

The status of the online editing project. Valid values:

- Draft

- Editing

- Producing

- Produced

- ProduceFailed

- Deleted

Editing
CreateSourcestring

The method for creating the online editing project. Valid values:

- OpenAPI

- AliyunConsole

- WebSDK

- LiveEditingOpenAPI

- LiveEditingConsole

OpenAPI
TemplateTypestring

The template type of the online editing project. Valid values:

- Timeline

- VETemplate

Timeline
ModifiedSourcestring

The method for editing the online editing project. Valid values:

- OpenAPI

- AliyunConsole

- WebSDK

- LiveEditingOpenAPI

- LiveEditingConsole

OpenAPI
ProjectTypestring

The type of the editing project. Default value: EditingProject. Valid values:

- EditingProject: a regular editing project.

- LiveEditingProject: a live stream editing project.

EditingProject
BusinessConfigstring

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" }
BusinessStatusstring

The business status of the project. This parameter can be ignored for general editing projects. Valid values:

Reserving

ReservationCanceled

BroadCasting

LoadingFailed

LiveFinished

Reserving
TimelineConvertStatusstring

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
TimelineConvertErrorMessagestring

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

Sample success responses

JSONformat

{
  "RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
  "Project": {
    "ProjectId": "****fb2101bf24b2754cb318787dc****",
    "Title": "",
    "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****1656bca4474999c961a6d2a2****\"}]}]}",
    "TemplateId": "****96e8864746a0b6f3****",
    "ClipsParam": "",
    "Description": "",
    "CoverURL": "oss://example-bucket/example.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 codeError codeError message
400InvalidParameterThe specified parameter \ is not valid.

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