ListSearchLib - 获取搜索库列表

更新时间:
复制为 MD 格式

获取搜索库列表信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

PageNo

integer

当前页码。默认值为 1。

1

PageSize

integer

每页返回的数据条数。默认值为 10,最大值为 50。

10

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

******3B-0E1A-586A-AC29-742247******

Success

string

是否成功。

true

Code

string

返回码。

200

SearchLibInfoList

array<object>

搜索库信息列表。

array<object>

搜索库信息。

SearchLibName

string

搜索库。

faceSearchLib

Status

string

状态:

  • normal:正常

  • deleting:删除中

  • deleteFail:删除失败

枚举值:

  • normal :

    normal

  • deleting :

    deleting

  • deleteFail :

    deleteFail

normal

IndexInfo

array<object>

索引信息。

object

IndexType

string

索引类别。取值:

  • mm:大模型。

  • face:人脸。

  • aiLabel:智能标签。

face

IndexStatus

string

索引状态。默认值为 Active,取值:

  • Active:激活。

  • Deactive:失效。

Active

IndexReadiness

string

索引就绪状态。取值:

  • Initializing:激活。

  • Normal:失效。

  • Fail:失败。

Normal

SearchLibConfig

string

搜索库配置。

{"faceGroupIds":"xxx1,xxx2,xx3"}

Total

integer

总数。

8

示例

正常返回示例

JSON格式

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Success": "true",
  "Code": "200",
  "SearchLibInfoList": [
    {
      "SearchLibName": "faceSearchLib",
      "Status": "normal",
      "IndexInfo": [
        {
          "IndexType": "face",
          "IndexStatus": "Active",
          "IndexReadiness": "Normal"
        }
      ],
      "SearchLibConfig": "{\"faceGroupIds\":\"xxx1,xxx2,xx3\"}"
    }
  ],
  "Total": 8
}

错误码

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

变更历史

更多信息,参考变更详情