DescribeClusterDetail - - Centre de documentation Alibaba Cloud

Récupère les détails d'un cluster Container Service for Kubernetes (ACK) spécifique à l'aide de son ID.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Syntaxe de la requête

GET /clusters/ClusterId HTTP/1.1 
Content-Type:application/json

Paramètres de requête

Tableau 1. Paramètres de chemin de requête
Paramètre	Type	Obligatoire	Exemple	Description
ClusterId	String	Oui	cdde1f21ae22e483ebcb068a6eb7f****	L'ID du cluster ACK à interroger.

Syntaxe de la réponse

HTTP/1.1 200
Content-Type:application/json
{
  "cluster_id" : "String",
  "cluster_type" : "String",
  "created" : "String",
  "init_version" : "String",
  "current_version" : "String",
  "next_version" : "String",
  "deletion_protection" : Boolean,
  "docker_version" : "String",
  "external_loadbalancer_id" : "String",
  "meta_data" : "String",
  "name" : "String",
  "network_mode" : "String",
  "region_id" : "String",
  "resource_group_id" : "String",
  "security_group_id" : "String",
  "size" : Long,
  "state" : "String",
  "tags" : [ {
    "key" : "String",
    "value" : "String"
  } ],
  "updated" : "String",
  "vpc_id" : "String",
  "vswitch_id" : "String",
  "subnet_cidr" : "String",
  "zone_id" : "String",
  "master_url" : "String",
  "private_zone" : Boolean,
  "profile" : "String",
  "cluster_spec" : "String",
  "worker_ram_role_name" : "String",
  "maintenance_window" : {
    "enable" : Boolean,
    "maintenance_time" : "String",
    "duration" : "String",
    "weekly_period" : "String"
  }
}

Paramètres de réponse

Tableau 2. Paramètres du corps de la réponse
Paramètre	Type	Exemple	Description
cluster_id	String	c82e6987e2961451182edacd74faf****	L'ID du cluster ACK interrogé.
cluster_type	String	Kubernetes	Le type du cluster. Valeurs possibles : `Kubernetes` : cluster Kubernetes dédié `ManagedKubernetes` : cluster Kubernetes managé `Ask` : cluster ASK `ExternalKubernetes` : cluster Kubernetes externe enregistré
created	String	2019-11-25T15:50:20+08:00	La date et l'heure de création du cluster.
init_version	String	1.16.6-aliyun.1	La version initiale de Kubernetes utilisée par le cluster.
current_version	String	1.16.6-aliyun.1	La version actuelle de Kubernetes du cluster. Pour plus d'informations sur les versions de Kubernetes prises en charge par ACK, consultez les notes de publication des versions Kubernetes.
next_version	String	1.18.8-aliyun.1	La version de Kubernetes vers laquelle le cluster peut être mis à niveau.
deletion_protection	Boolean	true	Indique si la protection contre la suppression est activée. Si elle est activée, vous ne pouvez pas supprimer le cluster via la console ACK ni en appelant l'API. Valeurs possibles : `true` : La protection contre la suppression est activée. Vous ne pouvez pas supprimer le cluster via la console ACK ni en appelant l'API. `false` : La protection contre la suppression n'est pas activée. Vous pouvez supprimer le cluster via la console ACK ou en appelant l'API.
docker_version	String	19.03.5	La version de Docker utilisée par le cluster.
external_loadbalancer_id	String	lb-2ze3buguz3gx9920z****	L'ID de l'instance Server Load Balancer (SLB) utilisée pour l'Ingress du cluster.
meta_data	String	\"Addons\":***	Les métadonnées du cluster.
name	String	cluster-demo	Le nom du cluster. Le nom doit comporter entre 1 et 63 caractères et peut contenir des chiffres, des lettres et des traits d'union (-). Il ne peut pas commencer par un trait d'union (-).
network_mode	String	vpc	Le mode réseau du cluster. Valeurs possibles : `classic` : réseau classique `vpc` : cloud privé virtuel (VPC) `overlay` : réseau overlay `calico` : réseau Calico Valeur par défaut `: vpc`.
region_id	String	cn-beijing	L'ID de la région où le cluster est déployé.
resource_group_id	String	rg-acfmyvw3wjm****	L'ID du groupe de ressources auquel appartient le cluster.
security_group_id	String	sg-25yq****	L'ID du groupe de sécurité auquel appartiennent les instances du cluster.
size	Long	5	Le nombre de nœuds du cluster, y compris les nœuds maîtres et les nœuds de travail.
state	String	running	L'état du cluster. Valeurs possibles : `initial` : Le cluster est en cours de création. `failed` : Échec de la création du cluster. `running` : Le cluster est en cours d'exécution. `updating` : Le cluster est en cours de mise à niveau. `updating_failed` : Échec de la mise à niveau du cluster. `scaling` : Le cluster est en cours de mise à l'échelle. `waiting` : Le cluster enregistré est en attente de connexion. `disconnected` : Le cluster enregistré est déconnecté. `stopped` : Le cluster est arrêté. `deleting` : Le cluster est en cours de suppression. `deleted` : Le cluster est supprimé. `delete_failed` : Échec de la suppression du cluster.
tags	Array of tag		Les tags du cluster.
updated	String	2020-01-13T23:01:03+08:00	La date et l'heure de la dernière mise à jour du cluster.
vpc_id	String	vpc-2zecuu62b9zw7a7qn****	L'ID du VPC où le cluster est déployé. Ce paramètre est obligatoire lors de la création d'un cluster ACK.
vswitch_id	String	vsw-2zete8s4qocqg0mf6**,vsw-2zete8s4qocqg0mf6**	Les ID des vSwitch. Vous pouvez sélectionner entre un et trois vSwitch lors de la création d'un cluster ACK. Nous vous recommandons d'utiliser des vSwitch situés dans différentes zones pour garantir une haute disponibilité.
subnet_cidr	String	172.20.0.0/16	Le bloc CIDR des pods. Il doit s'agir d'un bloc CIDR valide et privé, correspondant à l'un des blocs suivants ou à leurs sous-réseaux : 10.0.0.0/8 172.16-31.0.0/12-16 192.168.0.0/16 Le bloc CIDR des pods ne doit pas chevaucher celui du VPC ni ceux des clusters ACK déployés dans le VPC. Pour plus d'informations sur le découpage réseau des clusters ACK, consultez la rubrique Planification des blocs CIDR pour les clusters ACK dans un VPC.
zone_id	String	cn-beijing-a	L'ID de la zone où le cluster est déployé.
master_url	String	{\"intranet_api_server_endpoint\":\"https://192.168.0.251:6443\"***}	L'adresse du cluster. Elle comprend un endpoint interne et un endpoint public.
private_zone	Boolean	false	Indique si Alibaba Cloud DNS PrivateZone est activé. `true` : Alibaba Cloud DNS PrivateZone est activé. `false` : Alibaba Cloud DNS PrivateZone n'est pas activé.
profile	String	Default	Le scénario d'utilisation du cluster. Valeurs possibles : `Default` : le cluster est utilisé dans des scénarios autres que l'informatique en périphérie. `Edge` : le cluster ACK est utilisé dans des scénarios d'informatique en périphérie.
cluster_spec	String	ack.pro.small	Le type du cluster Kubernetes managé. Ce paramètre est renvoyé uniquement pour les clusters Kubernetes managés. Valeurs possibles : `ack.pro.small` : cluster Kubernetes managé professionnel. `ack.standard` : cluster Kubernetes managé standard.
worker_ram_role_name	String	KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****	Le nom du rôle RAM des nœuds de travail. Ce rôle est attribué aux nœuds de travail du cluster et leur permet de gérer les instances Elastic Compute Service (ECS).
maintenance_window	maintenance_window		La fenêtre de maintenance du cluster. Cette fonctionnalité est disponible uniquement pour les clusters Kubernetes managés professionnels.

Exemples

Exemple de requête

GET /clusters/cdde1f21ae22e483ebcb068a6eb7f**** HTTP/1.1 
Content-Type:application/json

Exemple de réponse réussie

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<cluster_id>c82e6987e2961451182edacd74faf****</cluster_id>
<cluster_type>Kubernetes</cluster_type>
<created>2019-11-25T15:50:20+08:00</created>
<init_version>1.16.6-aliyun.1</init_version>
<current_version>1.16.6-aliyun.1</current_version>
<next_version>1.18.8-aliyun.1</next_version>
<deletion_protection>true</deletion_protection>
<docker_version>19.03.5</docker_version>
<external_loadbalancer_id>lb-2ze3buguz3gx9920z****</external_loadbalancer_id>
<meta_data>\"Addons\":***</meta_data>
<name>cluster-demo</name>
<network_mode>vpc</network_mode>
<region_id>cn-beijing</region_id>
<resource_group_id>rg-acfmyvw3wjm****</resource_group_id>
<security_group_id>sg-25yq****</security_group_id>
<size>5</size>
<state>running</state>
<tags>
    <key>env</key>
    <value>prod</value>
</tags>
<updated>2020-01-13T23:01:03+08:00</updated>
<vpc_id>vpc-2zecuu62b9zw7a7qn****</vpc_id>
<vswitch_id>vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****</vswitch_id>
<subnet_cidr>172.20.0.0/16</subnet_cidr>
<zone_id>cn-beijing-a</zone_id>
<master_url>{\"intranet_api_server_endpoint\":\"https://192.168.0.251:6443\"***}</master_url>
<private_zone>false</private_zone>
<profile>Default</profile>
<cluster_spec>ack.pro.small</cluster_spec>
<worker_ram_role_name>KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****</worker_ram_role_name>
<maintenance_window>
    <enable>false</enable>
    <maintenance_time>03:00:00Z</maintenance_time>
    <duration>3h</duration>
    <weekly_period>Monday,Thursday</weekly_period>
</maintenance_window>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "cluster_id" : "c82e6987e2961451182edacd74faf****",
  "cluster_type" : "Kubernetes",
  "created" : "2019-11-25T15:50:20+08:00",
  "init_version" : "1.16.6-aliyun.1",
  "current_version" : "1.16.6-aliyun.1",
  "next_version" : "1.18.8-aliyun.1",
  "deletion_protection" : true,
  "docker_version" : "19.03.5",
  "external_loadbalancer_id" : "lb-2ze3buguz3gx9920z****",
  "meta_data" : "\\\"Addons\\\":***",
  "name" : "cluster-demo",
  "network_mode" : "vpc",
  "region_id" : "cn-beijing",
  "resource_group_id" : "rg-acfmyvw3wjm****",
  "security_group_id" : "sg-25yq****",
  "size" : 5,
  "state" : "running",
  "tags" : [ {
    "key" : "env",
    "value" : "prod"
  } ],
  "updated" : "2020-01-13T23:01:03+08:00",
  "vpc_id" : "vpc-2zecuu62b9zw7a7qn****",
  "vswitch_id" : "vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****",
  "subnet_cidr" : "172.20.0.0/16",
  "zone_id" : "cn-beijing-a",
  "master_url" : "{\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.0.251:6443\\\"***}",
  "private_zone" : false,
  "profile" : "Default",
  "cluster_spec" : "ack.pro.small",
  "worker_ram_role_name" : "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
  "maintenance_window" : {
    "enable" : false,
    "maintenance_time" : "03:00:00Z",
    "duration" : "3h",
    "weekly_period" : "Monday,Thursday"
  }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.