接口描述
接口名称:
/Project/DescribeProjects
。接口功能:查询项目,支持根据项目 ID 和项目类别查询项目信息。
调用方式
输入参数
字段 | 类型 | 必填 | 描述 |
ProjectIds | String | 否 | 项目 ID 集合,数组长度不得超过20。 |
Category | String | 否 | 分类集合,取值: Default:普通编辑项目; Live:直播剪辑项目; VideoSegmentation:视频拆条项目; Switcher:导播台项目。 StreamConnect:云转推项目。 |
Name | String | 否 | 项目名称,长度限制:30个字符。 |
Sort | 否 | 排序方式。Sort.Field 可选值:CreateTime。注意:指定 Text 搜索时,将根据匹配度排序,该字段无效。 | |
Offset | Integer | 否 | 偏移量。默认值:0。 |
Limit | Integer | 否 | 返回记录条数,默认值:50。 |
输出参数
字段 | 类型 | 描述 |
TotalCount | Integer | 符合条件的记录总数。 |
ProjectInfoSet | Array of ProjectInfo | 项目信息。 |
示例
示例1:查询项目成功
查询 Category 为
Default
的项目,返回成功。输入示例
{"Category": "Default","Limit": 1}
输出示例
{"Code": "Success","Message": "成功","EnglishMessage": "success","Data": {"TotalCount": 2,"ProjectInfoSet": [{"ProjectId": "cmepid_5fbb72524e70c2000192d4ed","Owner": {"Id": "ce4cdaf6-6039-486b-8f09-a5df23dbe6c9","Type": "PERSON"},"Category": "Default","Name": "招生通0821","WHRatio": "16:9","CoverUrl": "https://cme.vod2.myqcloud.com/1810000003/8d388657vodtranscq1810000003/5fdf8be75285890810291911580/coverBySnapshot/coverBySnapshot_10_0.jpg","FusionData": "[{\\"id\\":\\"adaaada6-efb6-428c-ae6f-b857aaf0f138\\",\\"type\\":\\"video\\",\\"order\\":0,\\"items\\":[{\\"id\\":\\"90c8f037-4826-467e-ab52-884f4728b3de\\",\\"start_time\\":0,\\"duration\\":95120,\\"type\\":\\"video\\",\\"section\\":{\\"from\\":0,\\"to\\":95120},\\"asset_id\\":\\"5eb62431580361000131369c\\",\\"filter_asset_id\\":\\"\\",\\"width\\":954,\\"height\\":540,\\"position\\":{\\"x\\":480,\\"y\\":270},\\"operations\\":[{\\"type\\":\\"image_rotate\\",\\"params\\":{\\"angle\\":0}}]}]}]","Version": 1608449142,"CreateTime": "2020-11-23T08:26:58Z","UpdateTime": "2020-12-20T07:25:42Z"}]}}
示例2:查询项目失败
查询 Category 为
Live
的项目,返回成功。输入示例
{"Category": "Live","Limit": 1}
输出示例
{"Code": "ResourceNotFound","Message": "资源不存在","EnglishMessage": "resource not found"}