入库相关接口
更新时间：2022-08-25
视频入库
接口描述
本接口用于向视频库中插入视频特征。
- 视频路径支持BOS、HTTP(S) URL路径；
- 入库接口为异步接口，可通过查询视频入库结果接口查询入库结果。或通过通知服务回调结果。
请求结构
PUT /v{version}/videolib/{libName}
host: mms.bj.baidubce.com
Authorization: <bce-authorization-string>
{
"source": videoUrl,
"description": desc,
"notification": notificationName
}请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| libName | String | 是 | URL参数 | 用户的视频库名称 |
| source | String | 是 | Body参数 | 入库视频的URL |
| description | String | 否 | Body参数 | 用户对此次请求的描述 |
| notification | String | 否 | Body参数 | 入库结果通知的名称 |
- 注：如使用notification参数，需提前配置通知名称及对应的回调地址。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 请求结果 |
| mediaId | String | 视频ID |
请求示例
PUT /v2/videolib/baiduyun_test
host: mms.bj.baidubce.com
Authorization: <bce-authorization-string>
{
"source": "http://test.mp4",
"description": "test",
"notification": "notification_name"
}响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "success",
"mediaId": "5kLYVn0BePlv8pCO1RCO"
}通知服务回调结果示例
{
"messageId": "a114f8e1-0de0-473f-9f6c-d47e33df5d7d",
"messageBody": "{\"taskId\":\"n7CCcHIBTmikKXpp-AS8\",\"status\":\"success\",\"source\":\"http://bj.bcebos.com/v1/bucket/test.mp4\",\"duration\":6.5,\"description\":\"\",\"createTime\":\"2020-06-01T15:32:11Z\",\"startTime\":\"2020-06-01T15:32:11Z\",\"updateTime\":\"2020-06-01T15:32:13Z\",\"finishTime\":\"2020-06-01T15:32:13Z\"}"
}查询视频入库结果
接口描述
本接口用于查询视频入库结果。
请求结构
GET /v{version}/videolib/{libId}?mediaId={mediaId}&getInsertResponseById
host: mms.bj.baidubce.com
Authorization: <bce-authorization-string>请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| libId | String | 是 | URL参数 | 用户的视频库ID |
| mediaId | String | 是 | URL参数 | 入库视频的ID |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 入库任务状态，取值为provision/processing/success/failed，分别为排队中/处理中/成功/失败 |
| description | String | 用户入库请求传入的description字段 |
| source | String | 入库视频的URL |
请求示例
GET /v2/videolib/video_xxx?mediaId={mediaId}&getInsertResponseById
host: mms.bj.baidubce.com
Authorization: <bce-authorization-string>响应示例
入库中
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"createTime": "2020-05-13T07:57:25Z",
"description": "",
"source": "http://bj.bcebos.com/v1/test.mp4",
"startTime": "2020-05-13T07:57:26Z",
"status": "processing"
}入库完成
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"createTime": "2020-05-13T07:55:55Z",
"description": "",
"duration": 6.5,
"finishTime": "2020-05-13T07:55:57Z",
"source": "http://bj.bcebos.com/v1/test.mp4",
"startTime": "2020-05-13T07:55:55Z",
"status": "success"
}图片入库
接口描述
本接口用于向图片库中插入图片特征。
- 图片路径支持BOS、HTTP(S) URL路径；
- 图片格式支持jpg、JPG、png、PNG、jpeg、JEPG格式；
请求结构
PUT /v{version}/imagelib/{libName}
host: mms.bj.baidubce.com
Authorization: <bce-authorization-string>
{
"source": imageUrl,
"description": desc
}请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| libName | String | 是 | URL参数 | 用户的图片库名称 |
| source | String | 是 | Body参数 | 入库图片的URL |
| description | String | 否 | Body参数 | 用户对此次请求的描述 |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| status | String | 入库结果 |
| mediaId | String | 图片ID |
请求示例
PUT /v2/imagelib/baiduyun_test
host: mms.bj.baidubce.com
Authorization: <bce-authorization-string>
{
"source": "http://test.jpg",
"description": "test"
}
**响应示例**
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"status": "success",
"mediaId": "ykLlVn0BePlv8pCOv1dX"
}