调用IndexVideo接口将视频添加到媒体集中,并对视频进行自动截帧、分组、识别等操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Project | string | 是 | 项目名称。 | immvideotest |
SetId | string | 是 | 媒体集的唯一标识。 | videotest |
VideoUri | string | 是 | 视频的OSS URI。 OSS地址规则为 | oss://imm-test/testcases/video.mp4 |
RemarksA | string | 否 | 标记信息,为使用者预留的筛选参数,用于记录所需要的信息。 在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:
| AdminGroup/AdminUserA/ |
RemarksB | string | 否 | 标记信息,为使用者预留的筛选参数,用于记录所需要的信息。 在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:
| nas://path/to/file |
TgtUri | string | 否 | 存储数据的OSS地址。不支持此参数。 | oss://imm-test/testcases |
RemarksC | string | 是 | 标记信息,为使用者预留的筛选参数,用于记录所需要的信息。 在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:
| remarkc |
RemarksD | string | 否 | 标记信息,为使用者预留的筛选参数,用于记录所需要的信息。 在搜索等场景下,您可以以前缀匹配的方式将设置的值作为搜索条件,样例场景如下:
| remarkd |
ExternalId | string | 否 | 外部ID,用于和您的应用层的ID(如果有)进行绑定。 | externalId001 |
NotifyTopicName | string | 否 | 异步反向通知的TopicName。 | topic2 |
NotifyEndpoint | string | 否 | 异步反向通知的Endpoint,视频处理结果可以通过该Endpoint异步通知给调用者。使用此功能需要先开通MNS服务,新建topic和queue,并配置订阅关系。具体操作,请参见消息服务MNS快速入门概述。 说明MNS服务和智能媒体管理必须处于同一地域。 | http://1111111111.mns.cn-hangzhou.aliyuncs.com |
返回参数
示例
正常返回示例
JSON
格式
{
"ModifyTime": "2021-01-21T07:40:41.683Z",
"RequestId": "896ABAD1-C452-4BED-B5E0-302955F8BAB5",
"CreateTime": "2021-01-21T07:40:41.683Z",
"ExternalId": "externalId001",
"VideoUri": "oss://imm-test/testcases/video.mp4",
"RemarksA": "AdminGroup/AdminUserA/",
"RemarksB": "nas://path/to/file",
"RemarksC": "remarkc",
"RemarksD": "remarkd",
"SetId": "videoset"
}
错误码
访问错误中心查看更多错误码。