InsertMediaToSearchLib - 插入媒资到搜索库 - 智能媒体服务

接口说明

前提条件

插入媒资到搜索库前，需要调用 CreateSearchLib 接口建立好搜索库。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:InsertMediaToSearchLib

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SearchLibName	string	否	搜索库名称。需要调用 CreateSearchLib 接口提前建立好搜索库。	test1
MediaId	string	否	媒资 ID。具有唯一性，不填会自动生成。	411bed50018971edb60b0764a0ec6***
MediaType	string	否	媒资类型。默认值 video。 video 视频 image 图片 audio 音频枚举值： image : image video : video audio : audio	video
Input	string	是	需要入库的视频、音频或图片文件的地址，请勿使用临时地址，需保证源文件可以被访问。说明请确认您的文件名正确且所在 Bucket 与接口调用地域一致，否则可能导致找不到文件或接口调用失败。 OSS 地址（推荐）：oss://[Bucket 名称]/[文件路径]，例如 oss://[example-bucket-]/[object_path-]。 HTTP 地址：公网可下载的地址，例如 http://example-test-****.mp4。	oss://[example-bucket-]/[object_path-]
MsgBody	string	否	媒资信息。JSON 字符串。支持字段： title，标题，string 类型 customFields，自定义字段，JSONObject，参数不支持修改；支持 Int 型 intField1、string 型 strField1、strField2	{"title":"test","customFields":{"intField1":12,"strField1":"abc"}}
ImagesInput	string	否	图片集信息。仅支持 IPCamera 场景，MediaType 需为 video。	{ "images": [ "oss://[example-bucket-]/[object_path-]xxx1.jpg", "oss://[example-bucket-]/[object_path-]xxx2.jpg", "oss://[example-bucket-]/[object_path-]xxx3.jpg", "oss://[example-bucket-]/[object_path-]xxx4.jpg" ] }
Namespace	string	否	命名空间。	name-1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	***ACB-44F2-5F2D-88D7-1283E70***
MediaId	string	媒资 ID。	**20b48fb04483915d4f2cd8ac**
Success	string	是否调用成功。取值： true：成功 false：失败	true
Code	string	返回码。	200

示例

正常返回示例

JSON格式

{
  "RequestId": "*****ACB-44F2-5F2D-88D7-1283E70*****",
  "MediaId": "****20b48fb04483915d4f2cd8ac****",
  "Success": "true",
  "Code": "200"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。