DescribeClusterDetail - Container Service for Kubernetes: Central de Documentação do Alibaba Cloud

Consulta os detalhes de um cluster especificado pelo ID do cluster.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cs:DescribeClusterDetail

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

Nenhuma

Sintaxe da solicitação

GET /clusters/{ClusterId} HTTP/1.1

Parâmetros de caminho

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

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros do corpo da resposta.
auto_mode	object	A configuração do modo gerenciado inteligente.
enable	boolean	Indica se o modo gerenciado inteligente está ativado.	false
cluster_domain	string	O nome de domínio local do cluster.	cluster.local
cluster_id	string	O ID do cluster.	c82e6987e2961451182edacd74faf****
cluster_spec	string	A especificação do cluster quando `cluster_type` é definido como `ManagedKubernetes` e `profile` é configurado. Valores válidos: `ack.standard`: Basic (selecionado por padrão se o valor estiver vazio) `ack.pro.small`: Pro `ack.pro.xlarge`: Pro XL `ack.pro.2xlarge`: Pro 2XL `ack.pro.4xlarge`: Pro 4XL (entre em contato com o atendimento ao cliente para adicionar sua conta à lista de permissões) Pro XL, Pro 2XL e Pro 4XL são três níveis fornecidos pelo Plano de controle provisionado do ACK Pro. Ao pré-alocar e dedicar recursos do plano de controle, esses níveis garantem que a simultaneidade da API e os recursos de agendamento de Pod permaneçam em um nível alto determinístico. Eles são adequados para treinamento e inferência de IA, clusters de escala ultragrande e cargas de trabalho de missão crítica. Para obter informações sobre as taxas de gerenciamento de cluster para as edições Pro e de plano de controle provisionado, consulte Taxas de gerenciamento de cluster.	ack.pro.small
cluster_type	string	O tipo de cluster. Valores válidos: `Kubernetes`: cluster dedicado do ACK. `ManagedKubernetes`: tipos de cluster ACK ACK, incluindo clusters ACK ACK (ACK Pro e ACK Basic), clusters ACK Serverless (Pro e Basic), clusters ACK Edge (Pro e Basic) e clusters ACK Lingjun (Pro). `ExternalKubernetes`: cluster registrado.	Kubernetes
container_cidr	string	O bloco CIDR do Pod para a configuração de rede Flannel.	172.20.xx.xx/16
control_plane_config	object	A configuração do plano de controle para clusters dedicados.
auto_renew	boolean	Indica se a renovação automática está ativada para os nós.	true
auto_renew_period	integer	O período de renovação automática para os nós.	1
charge_type	string	O método de cobrança dos nós do plano de controle.	PrePaid
cloud_monitor_flags	boolean	Indica se o agente do CloudMonitor está instalado nos nós.	true
cpu_policy	string	A política de gerenciamento de CPU para os nós.	none
deploymentset_id	string	O ID do conjunto de implantação.	ds-bp10b35imuam5amw****
image_id	string	O ID da imagem.	aliyun_3_x64_20G_alibase_20240819
image_type	string	O tipo de imagem do sistema operacional.	AliyunLinux3
instance_metadata_options	InstanceMetadataOptions	A configuração de acesso a metadados para instâncias ECS.
instance_types	array	Os tipos de instância para os nós.
	string	O tipo de instância.	ecs.g6.large
key_pair	string	O nome do par de chaves. Especifique este parâmetro ou login_password.	ack
node_port_range	string	O intervalo de portas de serviço do nó.	30000-32767
period	integer	A duração da assinatura para os nós.	1
period_unit	string	A unidade da duração da assinatura para os nós.	Month
runtime	string	O nome do runtime.	containerd
security_hardening_os	boolean	Indica se o endurecimento de segurança do Alibaba Cloud OS está ativado.	true
size	integer	O número de nós do plano de controle.	3
soc_enabled	boolean	Indica se o endurecimento de segurança de proteção classificada está ativado.	false
system_disk_bursting_enabled	boolean	Indica se o modo burst está ativado para o disco em nuvem do sistema dos nós.	true
system_disk_category	string	O tipo de disco em nuvem do sistema para os nós.	cloud_essd
system_disk_performance_level	string	O nível de desempenho do disco em nuvem do sistema para os nós. Este parâmetro entra em vigor apenas para discos em nuvem ESSD.	PL1
system_disk_provisioned_iops	integer	O IOPS de leitura/gravação provisionado do disco em nuvem do sistema para os nós.	1000
system_disk_size	integer	O tamanho do disco em nuvem do sistema para os nós. Valor mínimo: 40.	120
system_disk_snapshot_policy_id	string	A política de backup de snapshot automático para os nós.	sp-2zej1nogjvovnz4z****
control_plane_endpoints_config	object	A configuração de conexão do cluster.
internal_dns_config	object	A configuração de nome de domínio interno para o cluster. Este parâmetro se aplica a clusters gerenciados pelo ACK. O nome de domínio interno é usado por componentes do sistema do lado do nó, como kubelet e kube-proxy, para acessar o servidor de API. Se o acesso por nome de domínio interno não estiver ativado, os componentes do sistema do lado do nó acessam o servidor de API por meio do endereço IP do CLB.
bind_vpcs	array	O escopo de VPC no qual a resolução de registro de nome de domínio interno entra em vigor. Por padrão, isso inclui a VPC onde o cluster reside.
	string	A VPC na qual a resolução de registro de nome de domínio interno entra em vigor.	vpc-xxxxxx
enabled	boolean	Indica se o acesso por nome de domínio interno está ativado para o cluster. true: O acesso por nome de domínio interno está ativado. Os componentes do lado do nó (kubelet, kube-proxy) acessam o servidor de API por meio do nome de domínio interno.	true
load_balancers_config	array<object>	A configuração de balanceamento de carga para acesso ao cluster.
	object
endpoint	string	O endpoint de acesso.	nlb-0ogk9aaxxxxxxx.cn-hangzhou.nlb.aliyuncsslb.com
endpoint_type	string	O tipo de endpoint.	private
load_balancer_id	string	A instância de SLB associada ao endpoint.	nlb-0ogk9aaxxxxxxx
created	string	A hora em que o cluster foi criado.	2025-04-07T09:57:26+08:00
current_version	string	A versão atual do cluster. Para obter mais informações sobre as versões do Kubernetes compatíveis com o ACK, consulte Visão geral do lançamento de versões do Kubernetes.	1.32.1-aliyun.1
deletion_protection	boolean	Indica se a proteção contra exclusão está ativada para o cluster para evitar exclusão acidental pelo console ou API. Valores válidos: `true`: A proteção contra exclusão está ativada. O cluster não pode ser excluído pelo console ou API. `false`: A proteção contra exclusão não está ativada. O cluster pode ser excluído pelo console ou API.	true
docker_version `deprecated`	string	A versão do Docker usada no cluster.	19.03.5
external_loadbalancer_id `deprecated`	string	O ID da instância do SLB associado ao Ingress do cluster.	lb-2zehc05z3b8dwiifh****
extra_sans	array	Os Nomes Alternativos do Assunto (SANs) personalizados para o certificado do servidor de API.
	string	O SAN do certificado.	192.168.xx.xx
init_version	string	A versão inicial do cluster.	1.32.1-aliyun.1
ip_stack	string	A pilha de protocolos IP do cluster. Valores válidos: ipv4: cria um cluster que suporta apenas a pilha de protocolos IPv4. dual: cria um cluster que suporta a pilha dupla IPv4/IPv6.	ipv4
maintenance_window	maintenance_window	A configuração da janela de manutenção do cluster. Esta configuração entra em vigor apenas para clusters gerenciados (clusters ACK Pro).
master_url	string	Os endpoints de acesso do cluster, incluindo o endpoint de acesso à rede interna e o endpoint de acesso à rede pública.	{\"intranet_api_server_endpoint\":\"https://192.168.xx.xx:6443\"***}
meta_data	string	Os metadados do cluster.	\"Addons\":***
name	string	O nome do cluster.	cluster-demo
network_mode `deprecated`	string	O tipo de rede usado pelo cluster, como VPC.	vpc
next_version	string	A versão para a qual o cluster pode ser atualizado.	1.xx.x-aliyun.1
node_cidr_mask	string	Aplicável apenas ao plugin de rede de contêiner Flannel. O tamanho da máscara de sub-rede atribuído a cada nó, que controla o número de endereços IP que podem ser alocados ao nó.	26
operation_policy	object	A política de O&M automático do cluster.
cluster_auto_upgrade	object	A configuração de atualização automática do cluster.
channel	string	A frequência de atualização automática do cluster. Para obter mais informações, consulte Frequência de atualização. Valores válidos: patch: a versão de patch mais recente. stable: a segunda versão secundária mais recente. rapid: a versão secundária mais recente.	patch
enabled	boolean	Indica se a atualização automática do cluster está ativada.	true
parameters `deprecated`	object	A coleção de parâmetros do Resource Orchestration Service (ROS) para o cluster.
	string	O parâmetro do ROS.	"ALIYUN::Region": "cn-qingdao"
private_zone `deprecated`	boolean	Indica se o PrivateZone está ativado para o cluster. `true`: Ativado. `false`: Não ativado. Valor padrão: false.	false
profile	string	O subtipo do cluster. `Default`: Cluster gerenciado pelo ACK, incluindo clusters ACK Pro e ACK ACK. `Edge`: Cluster ACK Edge, incluindo clusters ACK Edge Pro e ACK Edge ACK. `Serverless`: Cluster ACK Serverless, incluindo clusters ACK Serverless Pro e ACK Serverless ACK. `Lingjun`: Cluster ACK Lingjun, disponível na edição Pro.	Default
proxy_mode	string	O modo kube-proxy. `iptables`: Um modo kube-proxy maduro e estável. A descoberta de serviços e o balanceamento de carga para Serviços do Kubernetes são configurados usando regras do iptables. O desempenho é moderado e afetado pela escala do cluster. Este modo é adequado para clusters com um pequeno número de Serviços. `ipvs`: Um modo kube-proxy de alto desempenho. A descoberta de serviços e o balanceamento de carga para Serviços do Kubernetes são configurados usando o módulo IPVS do Linux. Este modo é adequado para clusters com um grande número de Serviços que exigem alto desempenho de balanceamento de carga.	ipvs
region_id	string	O ID da região onde o cluster está implantado.	cn-beijing
resource_group_id	string	O ID do grupo de recursos ao qual o cluster pertence.	rg-acfmyvw3wjm****
rrsa_config	object	A configuração de RAM Roles for Service Accounts (RRSA).
audience	string	O público-alvo padrão do token OIDC. Vários valores são separados por vírgulas (,). Os valores são incluídos como uma matriz no campo aud do token OIDC.	https://kubernetes.default.svc,https://example.***.com
enabled	boolean	Indica se o RRSA está ativado.	true
issuer	string	O emissor do token OIDC. Vários valores são separados por vírgulas (,). O primeiro valor é usado como o campo iss no token OIDC e como a URL do emissor do provedor de identidade OIDC.	https://oidc-ack-***,https://kubernetes.default.svc
jwks_url	string	A URL das informações da chave pública OIDC.	https://oidc-ack-*/c12b990*/keys
max_oidc_token_expiration	string	O período de validade máximo configurável do token OIDC.	12h
oidc_arn	string	O Alibaba Cloud Resource Name (ARN) do provedor de identidade OIDC.	acs:ram::1138*:oidc-provider/ack-rrsa-*
oidc_name	string	O nome do provedor de identidade OIDC.	ack-rrsa-***
open_api_configuration_url	string	A URL do documento de configuração OIDC.	https://oidc-ack-*/c12b990*/.well-known/openid-configuration
security_group_id	string	O ID do grupo de segurança associado ao cluster.	sg-25yq****
service_cidr	string	O bloco CIDR da rede de serviço.	172.21.xx.xx/20
size	integer	O número de nós no cluster, incluindo nós master e nós worker.	5
state	string	O status do cluster. Valores válidos: `initial`: O cluster está sendo criado. `failed`: Falha ao criar o cluster. `running`: O cluster está em execução. `updating`: O cluster está sendo atualizado. `upgrading`: O cluster está passando por upgrade. `removing`: Os nós estão sendo removidos. `draining`: Os nós estão sendo drenados. `scaling`: O cluster está sendo escalonado. `inactive`: O cluster está inativo. `unavailable`: O cluster está indisponível. `deleting`: O cluster está sendo excluído. `deleted`: O cluster foi excluído. `delete_failed`: Falha ao excluir o cluster. `waiting`: O cluster está no estado acessado. `disconnected`: O cluster está desconectado.	running
subnet_cidr `deprecated`	string	O bloco CIDR do pod.	172.20.xx.xx/16
tags	array	As tags de recurso do cluster.
	tag	As tags de recurso do cluster.
timezone	string	O fuso horário.	Asia/Shanghai
updated	string	A hora em que o cluster foi atualizado pela última vez.	2025-04-10T13:28:09+08:00
vpc_id	string	O ID da VPC usada pelo cluster. Este parâmetro é obrigatório ao criar um cluster.	vpc-2zecuu62b9zw7a7qn****
vswitch_id `deprecated`	string	O ID do vSwitch. Este campo está obsoleto. Para consultar os vSwitches do plano de controle, use vswitch_ids. Para consultar os vSwitches do plano de dados, use vswitch_ids na configuração do pool de nós.	vsw-2zete8s4qocqg0mf6**,vsw-2zete8s4qocqg0mf6**
vswitch_ids	array	Os vSwitches usados pelo plano de controle do cluster.
	string	Os vSwitches usados pelo plano de controle do cluster.	vsw-2zete8s4qocqg0mf6****
worker_ram_role_name	string	O nome da função RAM do worker que autoriza as instâncias ECS a atuarem como nós worker do cluster.	KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****
zone_id `deprecated`	string	O ID da zona dentro da região onde o cluster reside.	cn-beijing-a

Exemplos

Resposta de sucesso

JSON formato

{
  "auto_mode": {
    "enable": false
  },
  "cluster_domain": "cluster.local",
  "cluster_id": "c82e6987e2961451182edacd74faf****",
  "cluster_spec": "ack.pro.small",
  "cluster_type": "Kubernetes",
  "container_cidr": "172.20.xx.xx/16",
  "control_plane_config": {
    "auto_renew": true,
    "auto_renew_period": 1,
    "charge_type": "PrePaid",
    "cloud_monitor_flags": true,
    "cpu_policy": "none",
    "deploymentset_id": "ds-bp10b35imuam5amw****",
    "image_id": "aliyun_3_x64_20G_alibase_20240819",
    "image_type": "AliyunLinux3",
    "instance_metadata_options": {
      "http_tokens": "optional"
    },
    "instance_types": [
      "ecs.g6.large"
    ],
    "key_pair": "ack",
    "node_port_range": "30000-32767",
    "period": 1,
    "period_unit": "Month",
    "runtime": "containerd",
    "security_hardening_os": true,
    "size": 3,
    "soc_enabled": false,
    "system_disk_bursting_enabled": true,
    "system_disk_category": "cloud_essd",
    "system_disk_performance_level": "PL1",
    "system_disk_provisioned_iops": 1000,
    "system_disk_size": 120,
    "system_disk_snapshot_policy_id": "sp-2zej1nogjvovnz4z****"
  },
  "control_plane_endpoints_config": {
    "internal_dns_config": {
      "bind_vpcs": [
        "vpc-xxxxxx"
      ],
      "enabled": true
    },
    "load_balancers_config": [
      {
        "endpoint": "nlb-0ogk9aaxxxxxxx.cn-hangzhou.nlb.aliyuncsslb.com",
        "endpoint_type": "private",
        "load_balancer_id": "nlb-0ogk9aaxxxxxxx"
      }
    ]
  },
  "created": "2025-04-07T09:57:26+08:00",
  "current_version": "1.32.1-aliyun.1",
  "deletion_protection": true,
  "docker_version": "19.03.5",
  "external_loadbalancer_id": "lb-2zehc05z3b8dwiifh****",
  "extra_sans": [
    "192.168.xx.xx"
  ],
  "init_version": "1.32.1-aliyun.1",
  "ip_stack": "ipv4",
  "maintenance_window": {
    "duration": "3h",
    "enable": false,
    "exclusions": [
      {
        "description": "Todas as alterações são proibidas durante o período de congelamento",
        "end_time": "2026-11-15T00:00:00+08:00",
        "scope": "NoOperations",
        "start_time": "2026-11-01T00:00:00+08:00"
      }
    ],
    "maintenance_time": "2020-10-15T12:31:00.000+08:00",
    "recurrence": "FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU",
    "weekly_period": "Monday,Thursday"
  },
  "master_url": "{\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.xx.xx:6443\\\"***}",
  "meta_data": "\\\"Addons\\\":***",
  "name": "cluster-demo",
  "network_mode": "vpc",
  "next_version": "1.xx.x-aliyun.1",
  "node_cidr_mask": "26",
  "operation_policy": {
    "cluster_auto_upgrade": {
      "channel": "patch",
      "enabled": true
    }
  },
  "parameters": {
    "key": "\"ALIYUN::Region\": \"cn-qingdao\""
  },
  "private_zone": false,
  "profile": "Default",
  "proxy_mode": "ipvs",
  "region_id": "cn-beijing",
  "resource_group_id": "rg-acfmyvw3wjm****",
  "rrsa_config": {
    "audience": "https://kubernetes.default.svc,https://example.***.com",
    "enabled": true,
    "issuer": "https://oidc-ack-***,https://kubernetes.default.svc",
    "jwks_url": "https://oidc-ack-***/c12b990***/keys",
    "max_oidc_token_expiration": "12h",
    "oidc_arn": "acs:ram::1138***:oidc-provider/ack-rrsa-***",
    "oidc_name": "ack-rrsa-***",
    "open_api_configuration_url": "https://oidc-ack-***/c12b990***/.well-known/openid-configuration"
  },
  "security_group_id": "sg-25yq****",
  "service_cidr": "172.21.xx.xx/20",
  "size": 5,
  "state": "running",
  "subnet_cidr": "172.20.xx.xx/16",
  "tags": [
    {
      "key": "env",
      "value": "prod"
    }
  ],
  "timezone": "Asia/Shanghai",
  "updated": "2025-04-10T13:28:09+08:00",
  "vpc_id": "vpc-2zecuu62b9zw7a7qn****",
  "vswitch_id": "vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****",
  "vswitch_ids": [
    "vsw-2zete8s4qocqg0mf6****"
  ],
  "worker_ram_role_name": "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
  "zone_id": "cn-beijing-a"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.