ListSearchLib - Intelligent Media Services - Alibaba Cloud Documentation Center

Retrieves a list of search libraries.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Max value: 50.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****3B-0E1A-586A-AC29-742247****
Success	string	Indicates whether the request was successful.	true
Code	string	The status code.	200
SearchLibInfoList	array<object>	Search library information.
	array<object>	Information about a search library.
SearchLibName	string	The search library.	faceSearchLib
Status	string	The status of the search library. Valid values: normal : The search library is in the normal state. deleting : The search library is being deleted. deleteFail : Failed to delete the search library.	normal
IndexInfo	array<object>	The index information.
	object
IndexType	string	The index type. Valid values: mm: Large language model (LLM). face: Face recognition. aiLabel: Smart tagging.	face
IndexStatus	string	The index status. Default value: Active. Valid values: Active: The index is active. Deactive: The index is inactive.	Active
IndexReadiness	string	The readiness status of the index. Valid values: Initializing: The index is being initialized. Normal: The index is ready. Fail: The index failed to be created.	Normal
SearchLibConfig	string	The search library configuration.	{"faceGroupIds":"xxx1,xxx2,xx3"}
Total	integer	The total number of entries.	8

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.