ListHotwordLibraries - - Centre de documentation Alibaba Cloud

Obtient les informations de toutes les bibliothèques de mots-clés en fonction de conditions spécifiées.

Description de l'opération

Cette opération interroge la liste de toutes les bibliothèques de mots-clés créées par les utilisateurs.
Vous pouvez utiliser le paramètre Name pour une recherche floue. La pagination et le filtrage par plage horaire sont pris en charge.
Par défaut, les résultats sont triés par ordre décroissant de l'heure de création. Vous pouvez utiliser le paramètre SortBy pour ajuster la méthode de tri.
Le nombre maximal d'enregistrements renvoyés par requête est de 100. La valeur par défaut est 10.
Vous pouvez utiliser le paramètre NextToken pour lire les données par pages.

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:ListHotwordLibraries

list

*Toutes les ressources.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
NextToken	string	Non	La position à partir de laquelle commencer la lecture.	**73f33c91-d59383e8280b**
PageNo	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 10. Valeur maximale : 100.	10
SortBy	string	Non	Le paramètre de tri. Par défaut, les résultats sont triés par ordre décroissant de l'heure de création.	CreationTime:Desc
Name	string	Non	Le nom de la bibliothèque de mots-clés.	Hotword library name
UsageScenario	string	Non	Les scénarios de la bibliothèque de mots-clés. Valeurs valides : ASR : Reconnaissance intelligente de texte ASR. StructuredMediaAssets : Actifs multimédias structurés. VideoTranslation : Traduction vidéo. Une fois la bibliothèque de mots-clés créée, ce champ ne peut pas être modifié.	ASR
StartTime	string	Non	L'heure de début pour le filtrage. L'heure est au format ISO 8601 et utilise l'heure UTC (se terminant par Z).	2020-12-26T04:11:10Z
EndTime	string	Non	L'heure de fin pour le filtrage. L'heure est au format ISO 8601 et utilise l'heure UTC (se terminant par Z).	2020-12-26T04:11:10Z
MaxResults	integer	Non	Le nombre maximal d'enregistrements renvoyés pour la requête en cours. Valeur maximale : 100. Valeur par défaut : 10.	10

É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.	**9262E3DA-07FA-4862-FCBB6BC61D08***
NextToken	string	La position jusqu'à laquelle l'appel en cours a lu. Une valeur vide indique que toutes les données ont été lues.	CBB6BC61D08
MaxResults	integer	Le nombre maximal d'enregistrements d'informations de bibliothèques de mots-clés renvoyés.	10
TotalCount	integer	Le nombre total de bibliothèques de mots-clés.	20
HotwordLibraryList	array<object>	La liste des bibliothèques de mots-clés.
	object
Description	string	La description. La longueur maximale est de 200 caractères.	Hotword library for celebrities
UsageScenario	string	Les scénarios de la bibliothèque de mots-clés. Valeurs valides : ASR : Reconnaissance intelligente de texte ASR. StructuredMediaAssets : Actifs multimédias structurés. VideoTranslation : Traduction vidéo. Une fois la bibliothèque de mots-clés créée, ce champ ne peut pas être modifié.	ASR
ModifiedTime	string	L'heure de modification. L'heure est au format ISO 8601 et utilise l'heure UTC (se terminant par Z).	2017-01-11T12:00:00Z
CreationTime	string	L'heure de création. L'heure est au format ISO 8601 et utilise l'heure UTC (se terminant par Z).	2017-01-11T12:00:00Z
HotwordLibraryId	string	L'identifiant de la bibliothèque de mots-clés.	a93b91141c0f422fa114af203f8b****
Name	string	Le nom de la bibliothèque de mots-clés.	my_hotwords

Exemples

JSON format

{
  "RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "NextToken": "CBB6BC61D08",
  "MaxResults": 10,
  "TotalCount": 20,
  "HotwordLibraryList": [
    {
      "Description": "Bibliothèque de mots clés contenant des noms de célébrités",
      "UsageScenario": "ASR",
      "ModifiedTime": "2017-01-11T12:00:00Z\n",
      "CreationTime": "2017-01-11T12:00:00Z",
      "HotwordLibraryId": "a93b91141c0f422fa114af203f8b****",
      "Name": "my_hotwords"
    }
  ]
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.