QuerySearchLib - - Centre de documentation Alibaba Cloud

Obtient les informations d'une bibliothèque de recherche.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ice:QuerySearchLib

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SearchLibName	string	Oui	Le nom de la bibliothèque de recherche.	test1

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	****11-DB8D-4A9A-875B-275798****
Success	string	Indique si l'appel a réussi. true : l'appel a réussi. false : l'appel a échoué.	true
Code	string	Le code d'état.	200
SearchLibName	string	Le nom de la bibliothèque de recherche.	test1
Status	string	L'état de la bibliothèque de recherche. Valeurs valides : normal : La bibliothèque de recherche est dans l'état normal. deleting : La bibliothèque de recherche est en cours de suppression. deleteFail : Échec de la suppression de la bibliothèque de recherche.	normal
IndexInfo	array<object>	Les informations de l'index.
	object
IndexType	string	Le type d'index. Valeurs valides : mm : grand modèle de langage (LLM). face : reconnaissance faciale. aiLabel : étiquetage intelligent.	face
IndexStatus	string	L'état de l'index. Valeurs valides : Active : l'index est actif. Deactive : l'index est inactif.	Active
IndexReadiness	string	L'état de préparation de l'index. Valeurs valides : Initializing : l'index est en cours d'initialisation. Normal : l'index est prêt. Fail : la création de l'index a échoué.	Normal
SearchLibConfig	string	La configuration de la bibliothèque de recherche.	{"faceGroupIds":"xxx1,xxx2,xx3"}

Exemples

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

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.