查询单个云剪辑工程的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:GetEditingProject | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectId | string | 是 | 云剪辑工程 ID | ****fb2101bf24b2754cb318787dc**** |
RequestSource | string | 否 | 请求来源标识 -OpenAPI:默认,不会做 timeline 转换操作。 -WebSDK:若传入该字段,则会自动将工程 timeline 转换为前端风格,并将 timleine 中关联素材和工程绑定,供前端 websdk 预览。 | WebSDK |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "****63E8B7C7-4812-46AD-0FA56029AC86****",
"Project": {
"ProjectId": "****fb2101bf24b2754cb318787dc****",
"Title": "样本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."
}
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidParameter | The specified parameter \ is not valid. |
访问错误中心查看更多错误码。