ListCategory - Alibaba Cloud Model Studio - Centre de documentation Alibaba Cloud

Obtient les détails d'une ou plusieurs catégories dans un espace de travail spécifié.

Description de l'opération

Cette API ne prend pas en charge l'interrogation des tables de données.
Pour appeler cette API, un utilisateur RAM doit d'abord obtenir l'autorisation d'API requise pour Model Studio et rejoindre un espace de travail. Cela nécessite l'autorisation AliyunBailianDataFullAccess, qui inclut l'autorisation sfm:ListCategory. Les comptes Alibaba Cloud peuvent appeler cette API directement. Utilisez la dernière version du SDK Model Studio.
Cette opération prend en charge la pagination. Lors de votre première requête, définissez le paramètre MaxResults pour spécifier le nombre maximal d'éléments à renvoyer. Si d'autres éléments sont disponibles, la réponse inclut un NextToken. Pour récupérer la page de résultats suivante, définissez le paramètre NextToken sur la valeur de la réponse précédente et spécifiez à nouveau MaxResults. Un NextToken vide indique qu'aucun autre résultat n'est disponible.
Cette opération est idempotente.

Limitation du débit : cette API est soumise à une limitation du débit. Ne dépassez pas 5 requêtes par seconde. Si le système limite le débit d'une requête, réessayez après un court intervalle.

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.

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.

Action	Niveau d'accès	Type de ressource	Clé de condition	Action dépendante
sfm:ListCategory	list	All Resource ``	Aucune	Aucune

Action

Niveau d'accès

Type de ressource

Clé de condition

Action dépendante

sfm:ListCategory

list

*All Resource

*

Aucune

Syntaxe de la requête

POST /{WorkspaceId}/datacenter/categories HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
WorkspaceId	string	Oui	L'identifiant de l'espace de travail. Pour plus de détails, consultez Utiliser les espaces de travail.	llm-3shx2gu255oqxxxx

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ConnectorId	string	Non	L'identifiant du connecteur.	file_conn_xxxxx
CategoryType	string	Oui	Le type de catégorie à interroger. Valeur valide : UNSTRUCTURED : une catégorie pour les données non structurées. RemarqueCette API ne prend pas en charge l'interrogation des tables de données structurées.	UNSTRUCTURED
ParentCategoryId	string	Non	L'identifiant de la catégorie parente.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
NextToken	string	Non	Le jeton de pagination. Pour récupérer la page de résultats suivante, transmettez la valeur NextToken de la réponse précédente.	AAAAAdH70eOCSCKtacdomNzak4U=
MaxResults	integer	Non	Le nombre maximal de catégories à renvoyer par page. La plage valide est de 1 à 200. Valeur par défaut : 20. Si ce paramètre n'est pas spécifié ou s'il est défini sur une valeur inférieure à 1, la valeur par défaut est utilisée. Si une valeur supérieure à 200 est spécifiée, la valeur maximale de 200 est utilisée.	20
CategoryName	string	Non	Filtre les résultats pour inclure uniquement la catégorie portant ce nom exact. Si ce paramètre est omis, aucun filtrage n'est appliqué.	产品清单

Éléments de réponse

Élément	Type	Description	Exemple
	object	L'objet de réponse.
Code	string	Le code d'erreur.	success
Data	object	La charge utile de la réponse.
CategoryList	array<object>	La liste des catégories.
	object	Un objet de catégorie.
CategoryId	string	The category ID.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CategoryName	string	The category name.	类目1
CategoryType	string	The category type. The only valid value is: `UNSTRUCTURED`: A standard category.	UNSTRUCTURED
IsDefault	boolean	Indicates whether the category is the default. Valid values: `true`: The category is the default. `false`: The category is not the default. You cannot delete the default category.	true
ParentCategoryId	string	The parent category ID.	cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
HasNext	boolean	Indique si d'autres résultats sont disponibles pour la récupération. Valeurs valides : true : d'autres résultats sont disponibles. false : il s'agit de la dernière page de résultats.	true
MaxResults	integer	Le nombre maximal de résultats à renvoyer par page.	20
NextToken	string	Le jeton utilisé pour récupérer la page de résultats suivante. Ce paramètre est omis lorsqu'aucun autre résultat n'est disponible.	AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ
TotalCount	integer	Le nombre total de catégories correspondantes.	20
Message	string	Le message d'erreur.	workspace id is null or invalid
RequestId	string	L'identifiant de la requête.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	Le code d'état de la requête.	200
Success	boolean	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true

Exemples

正常返回示例

JSON format

{
  "Code": "success",
  "Data": {
    "CategoryList": [
      {
        "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
        "CategoryName": "类目1",
        "CategoryType": "UNSTRUCTURED",
        "IsDefault": true,
        "ParentCategoryId": "cate_addd11b1b79a74e8bbd675c356a91ee3xxxxxxxx"
      }
    ],
    "HasNext": true,
    "MaxResults": 20,
    "NextToken": "AAAAALHWGpGoYCcYMxiFfmlhvh7Z4G8jiXR6IjHYd+M9WQVJ",
    "TotalCount": 20
  },
  "Message": "workspace id is null or invalid.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.