QuerySearchLib - 查询搜索库_智能媒体服务(IMS)-阿里云帮助中心

查询搜索媒资库信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ice:QuerySearchLib		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
SearchLibName	string	是	搜索库名称。	test1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	****11-DB8D-4A9A-875B-275798****
Success	string	表示是否调用成功： true：调用成功 false：调用失败	true
Code	string	返回码。	200
SearchLibName	string	搜索库名称。	test1
Status	string	状态：正常删除中删除失败枚举值： normal：normal。 deleting：deleting。 deleteFail：deleteFail。	normal
IndexInfo	array<object>	索引信息。
IndexInfo	object
IndexType	string	索引类别。取值： mm：大模型。 face：人脸。 aiLabel：智能标签。	face
IndexStatus	string	索引状态。取值： Active：激活。 Deactive：失效。	Active
IndexReadiness	string	索引就绪状态。取值： Initializing：激活。 Normal：失效。 Fail：失败。	Normal

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Success": "true",
  "Code": "200",
  "SearchLibName": "test1",
  "Status": "normal",
  "IndexInfo": [
    {
      "IndexType": "face",
      "IndexStatus": "Active",
      "IndexReadiness": "Normal"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-11-22	OpenAPI 返回结构发生变更	查看变更详情