Consultar os detalhes de um cluster - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Cabeçalhos da solicitação

Esta operação não possui cabeçalhos de solicitação específicos e utiliza apenas os cabeçalhos comuns. Para mais informações, consulte a seção "Parâmetros de solicitação comuns" no tópico Parâmetros comuns.

Sintaxe da solicitação

GET /clusters/{ClusterId} HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Posição	Obrigatório	Exemplo	Descrição
ClusterId	String	Path	Sim	cdde1f21ae22e483ebcb068a6eb7f****	O ID do cluster.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
cluster_id	String	c82e6987e2961451182edacd74faf****	O ID do cluster.
cluster_type	String	Kubernetes	O tipo do cluster. Valores válidos: `Kubernetes`: cluster dedicado do ACK. `ManagedKubernetes`: cluster gerenciado do ACK. Os clusters gerenciados do ACK incluem clusters ACK Pro, ACK Basic, ACK Serverless Pro, ACK Serverless Basic, ACK Edge Pro e ACK Edge Basic. `ExternalKubernetes`: cluster registrado.
created	String	2019-11-25T15:50:20+08:00	O horário de criação do cluster.
init_version	String	1.16.6-aliyun.1	A versão inicial do Kubernetes no cluster.
current_version	String	1.16.6-aliyun.1	A versão atual do Kubernetes no cluster. Para mais informações sobre as versões do Kubernetes suportadas pelo ACK, consulte Notas de lançamento das versões do Kubernetes.
deletion_protection	Boolean	true	Indica se a proteção contra exclusão está ativada para o cluster. Com essa proteção ativada, não é possível excluir o cluster pelo console do ACK ou por chamadas de API. Valores válidos: `true`: a proteção contra exclusão está ativada para o cluster. Nesse caso, o cluster não pode ser excluído pelo console do ACK ou por chamadas de API. `false`: a proteção contra exclusão está desativada para o cluster. Assim, o cluster pode ser excluído pelo console do ACK ou por chamadas de API.
docker_version	String	19.03.5	A versão do docker utilizada pelo cluster.
meta_data	String	\"Addons\":***	Os metadados do cluster.
name	String	cluster-demo	O nome do cluster. O nome deve ter entre 1 e 63 caracteres e pode conter dígitos, letras e hífens (-). O nome não pode começar com um hífen (-).
region_id	String	cn-beijing	O ID da região do cluster.
resource_group_id	String	rg-acfmyvw3wjm****	O ID do grupo de recursos ao qual o cluster pertence.
security_group_id	String	sg-25yq****	O ID do grupo de segurança ao qual as instâncias do cluster pertencem.
size	Long	5	A quantidade de nós no cluster. Inclui nós mestre e nós de trabalho.
state	String	running	O status do cluster. Valores válidos: `initial`: o cluster está sendo criado. `failed`: falha na criação do cluster. `running`: o cluster está em execução. `updating`: o cluster está sendo atualizado. `updating_failed`: falha na atualização do cluster. `scaling`: o cluster está em processo de dimensionamento. `waiting`: o cluster está aguardando solicitações de conexão. `disconnected`: o cluster está desconectado. `stopped`: o cluster está parado. `deleting`: o cluster está sendo excluído. `deleted`: o cluster foi excluído. `delete_failed`: falha na exclusão do cluster.
tags	Array of tag		Os rótulos de recurso do cluster.
updated	String	2020-01-13T23:01:03+08:00	O horário da última atualização do cluster.
vpc_id	String	vpc-2zecuu62b9zw7a7qn****	O ID da Virtual Private Cloud (VPC) onde o cluster está implantado. Este parâmetro é obrigatório ao criar um cluster.
vswitch_id	String	vsw-2zete8s4qocqg0mf6**,vsw-2zete8s4qocqg0mf6**	Os IDs dos vSwitches. É possível selecionar de um a três vSwitches durante a criação do cluster. Recomendamos escolher vSwitches em zonas diferentes para garantir alta disponibilidade.
subnet_cidr	String	172.20.0.0/16	O bloco CIDR dos pods. Deve ser um bloco CIDR privado e válido, correspondente a um dos seguintes blocos ou suas sub-redes: 10.0.0.0/8 172.16-31.0.0/12-16 192.168.0.0/16 O bloco CIDR dos pods não pode sobrepor-se ao bloco CIDR da VPC nem aos blocos CIDR de outros clusters na mesma VPC. Para mais informações, consulte Planejar blocos CIDR para um cluster ACK.
master_url	String	{\"intranet_api_server_endpoint\":\"https://192.168.0.251:6443\"***}	Os endpoints do cluster, incluindo um endpoint interno e um endpoint público.
profile	String	Default	O cenário de uso do cluster. Valores válidos: `Default`: cenários sem computação de borda. `Edge`: cenários de computação de borda.
cluster_spec	String	ack.pro.small	O tipo de cluster gerenciado do ACK. Este parâmetro aplica-se apenas a clusters gerenciados do ACK. Valores válidos: `ack.pro.small`: ACK Pro. `ack.standard`: ACK Basic.
worker_ram_role_name	String	KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****	O nome da função do Resource Access Management (RAM) do nó de trabalho. Essa função é atribuída aos nós de trabalho do cluster para permitir que eles gerenciem instâncias do Elastic Compute Service (ecs).
maintenance_window	maintenance_window		A janela de manutenção do cluster. Este recurso está disponível apenas em clusters ACK Pro.
parameters	Map		Os parâmetros do ROS do cluster.
	String	WorkerImageId	O parâmetro do ROS.

Exemplos

Exemplos de solicitação

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

Exemplos de respostas de sucesso

Formato XML

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>

Formato JSON

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

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.