QuerySearchLib - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries information about a search library.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:QuerySearchLib

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SearchLibName	string	Yes	The name of the search library.	test1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
Success	string	Indicates whether the call was successful. true: The call was successful. false: The call failed.	true
Code	string	The status code.	200
SearchLibName	string	The name of the search library.	test1
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 status of the index. 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"}

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.