GetEditingProject-Intelligent Media Services(IMS)-阿里云帮助中心

Queries the details of a single cloud 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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	Yes	The ID of the cloud editing project.	**fb2101bf24b2754cb318787dc**
RequestSource	string	No	The identifier of the request source. Valid values: OpenAPI: Default. No timeline conversion is performed. WebSDK: If this field is passed, the project timeline is automatically converted to the frontend style, and the associated media assets in the timeline are bound to the project for preview in the frontend WebSDK.	WebSDK

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	**63E8B7C7-4812-46AD-0FA56029AC86**
Project	object	The cloud editing project.
ProjectId	string	The ID of the cloud editing project.	**fb2101bf24b2754cb318787dc**
Title	string	The title of the cloud editing project.	Sample title
Timeline	string	The timeline of the cloud editing project.	{"VideoTracks":[{"VideoTrackClips":[{"MediaId":"**9b4d7cf14dc7b83b0e801cbe"},{"MediaId":"9b4d7cf14dc7b83b0e801cbe"},{"MediaId":"1656bca4474999c961a6d2a2**"}]}]}
TemplateId	string	The ID of the template.	**96e8864746a0b6f3**
ClipsParam	string	The media asset parameters corresponding to the template, in JSON format. When TemplateId is not empty, ClipsParam cannot be empty. For the specific format, see Create and use standard templates and Create and use advanced templates.	See the template usage documentation
Description	string	The description of the cloud editing project.	Sample description
CoverURL	string	The cover of the cloud editing project.	http://aaa.bbb/your-cover.jpg
CreateTime	string	The creation time of the cloud editing project. The time follows the ISO 8601 standard and is displayed in UTC (ending with Z).	2020-12-20T12:00:00Z
ModifiedTime	string	The last modified time of the cloud editing project. The time follows the ISO 8601 standard and is displayed in UTC (ending with Z).	2020-12-20T13:00:00Z
Duration	integer	The total duration of the cloud editing project.	24.120000
Status	string	The status of the cloud editing project. Valid values: Draft Editing Producing Produced ProduceFailed Deleted	Editing
CreateSource	string	The creation method of the cloud editing project. Valid values: OpenAPI AliyunConsole WebSDK LiveEditingOpenAPI LiveEditingConsole	OpenAPI
TemplateType	string	The template type of the cloud editing project. Valid values: Timeline VETemplate	Timeline
ModifiedSource	string	The editing method of the cloud editing project. Valid values: OpenAPI AliyunConsole WebSDK LiveEditingOpenAPI LiveEditingConsole	OpenAPI
ProjectType	string	The type of the editing project. Default value: EditingProject. Valid values: EditingProject: Standard editing project. LiveEditingProject: Live editing project.	EditingProject
BusinessConfig	string	The business configuration of the project. This can be ignored for standard 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 can be ignored for standard editing projects. Valid values: Reserving: Reserving. ReservationCanceled: Reservation canceled. BroadCasting: Broadcasting. LoadingFailed: Loading failed. LiveFinished: Live streaming finished.	Reserving
TimelineConvertStatus	string	The timeline conversion status of the project. Converting an API-style timeline to a frontend-style timeline is an asynchronous process and takes effect only when RequestSource is set to WebSDK. Valid values: Unconverted: The timeline is not converted. Converting: The project is being converted. Converted: The project conversion is completed. ConvertFailed: The project conversion failed.	Converted
TimelineConvertErrorMessage	string	The error message for project conversion failure. This is returned only when TimelineConvertStatus is ConvertFailed and contains detailed information about the conversion failure.	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": "Sample title",
    "Timeline": "{\"VideoTracks\":[{\"VideoTrackClips\":[{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****9b4d7cf14dc7b83b0e801cbe****\"},{\"MediaId\":\"****1656bca4474999c961a6d2a2****\"}]}]}",
    "TemplateId": "****96e8864746a0b6f3****",
    "ClipsParam": "See the template usage documentation",
    "Description": "Sample 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.