DescribeContainerCluster - - Centre de documentation Alibaba Cloud

Consulte un ou plusieurs clusters de conteneurs répondant aux conditions spécifiées.

Description de l'opération

Pris en charge uniquement pour l'intégration avec Container Service for Kubernetes (ACK).

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.

hbr:DescribeContainerCluster

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PageNumber	integer	Non	Le numéro de la page à renvoyer. La numérotation des pages commence à 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer par page. Valeurs valides : 1 à 99. Valeur par défaut : 10.	10
ClusterId	string	Non	L'identifiant du cluster.	cc-000*************hg9
Identifier	string	Non	L'identifiant du cluster de conteneurs. Pour un cluster Container Service for Kubernetes (ACK), spécifiez l'identifiant du cluster.	cca*******************************87a

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2
Success	boolean	Indique si l'appel a réussi. Valeurs valides : true : l'appel a réussi. false : l'appel a échoué.	true
Code	string	Le code d'état HTTP. Le code d'état 200 indique que l'appel a réussi.	200
Message	string	Le message renvoyé. Si l'appel réussit, la valeur « successful » est renvoyée. Si l'appel échoue, un message d'erreur est renvoyé.	successful
PageSize	integer	Le nombre d'entrées renvoyées par page. Valeurs valides : 1 à 99. Valeur par défaut : 10.	100
PageNumber	integer	Le numéro de la page renvoyée. La numérotation des pages commence à 1. Valeur par défaut : 1.	1
TotalCount	integer	Le nombre total d'entrées renvoyées.	8
Clusters	array<object>	Les informations sur les clusters.
	object	Les informations sur les clusters.
Token	string	Le jeton utilisé pour enregistrer le client Hybrid Backup Recovery (HBR) dans le cluster.	eyJhY2Nvd******A/VnZpgXQC5A==
Description	string	La description.	description ack pv backup
ClusterType	string	Le type du cluster. Valeur valide : ACK, ce qui correspond aux clusters ACK.	ACK
Identifier	string	L'identifiant du cluster.	c5bbd0931a30947f4ab85efd19380a72d
NetworkType	string	Le type de réseau du cluster. Valeurs valides : CLASSIC : le réseau classique VPC : le cloud privé virtuel (VPC)	VPC
Name	string	Le nom du cluster.	ack_pv_backup_location
AgentStatus	string	L'état du client. Valeurs valides : MISS : le client est déconnecté. UNKNOWN : le client est dans un état inconnu. READY : le client est prêt.	READY
ClusterId	string	L'identifiant du cluster.	cl-0006gwppd0jtttpmb0ri

Exemples

JSON format

{
  "RequestId": "CC94B755-C3C2-5B9D-BD77-E0FE819A4DB2",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageSize": 100,
  "PageNumber": 1,
  "TotalCount": 8,
  "Clusters": [
    {
      "Token": "eyJhY2Nvd******A/VnZpgXQC5A==",
      "Description": "description ack pv backup",
      "ClusterType": "ACK",
      "Identifier": "c5bbd0931a30947f4ab85efd19380a72d",
      "NetworkType": "VPC",
      "Name": "ack_pv_backup_location",
      "AgentStatus": "READY",
      "ClusterId": "cl-0006gwppd0jtttpmb0ri"
    }
  ]
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.