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

Consulta a lista de nós que atendem às condições especificadas em um 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:DescribeClusterNodes

get

*Cluster

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

Nenhuma

Sintaxe da solicitação

GET /clusters/{ClusterId}/nodes HTTP/1.1

Parâmetros de caminho

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceIds	string	Não	A lista de IDs de instâncias de nó. Separe vários IDs com vírgulas (,).	"i-bp11xjhwkj8k966u**,i-bp1dmhc2bu5igkyq**"
nodepool_id	string	Não	O ID do pool de nós.	npe25633140a7d4fbea56cd0479c******
state	string	Não	O status do nó do cluster. Filtra os nós por seu status de execução. Valores válidos: `all`: não filtra por status de execução. Consulta nós em todos os estados. `running`: nós em execução. `removing`: nós sendo removidos. `initial`: nós sendo inicializados. `failed`: nós cuja criação falhou. Valor padrão: `all`.	running
pageSize	string	Não	O número máximo de registros que podem ser exibidos por página. Valores válidos: [1,100]. Valor padrão: 10.	10
pageNumber	string	Não	O número da página da consulta atual. Valor padrão: 1.	1
nodeNames	string	Não		cn-hangzhou.192.168.0.1
nodeIps	string	Não		192.168.0.1
nodeLabels	string	Não		nodeLabels=app=nginx,env=prod

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
nodes	array<object>	A lista de detalhes dos nós.
	object	Os detalhes do nó.
creation_time	string	A hora em que o nó foi criado.	2025-04-16T07:28:00Z
error_message	string	A mensagem de erro gerada quando o nó foi criado.	error***
expired_time	string	A hora em que o nó expira.	2099-12-31T15:59:00Z
host_name	string	O nome do host do nó.	iZ2vcckdmxp7u0urj2k****
image_id	string	O ID da imagem do sistema usada pelo nó.	aliyun_3_x64_20G_alibase_20241218.vhd
instance_charge_type	string	O método de cobrança do nó. Valores válidos: `PrePaid`: assinatura. `PostPaid`: pago conforme o uso.	PostPaid
instance_id	string	O ID da instância do nó.	i-2vcckdmxp7u0urj2****
instance_name	string	O nome do nó no cluster.	worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****
instance_role	string	O tipo de função do nó. Valores válidos: Master: um nó mestre do cluster. Worker: um nó de trabalho do cluster.	Worker
instance_status	string	O status da ECS do nó. Valores válidos: `Pending`: sendo criada. `Running`: em execução. `Starting`: sendo iniciada. `Stopping`: sendo parada. `Stopped`: parada.	Running
instance_type	string	As especificações do nó.	ecs.c5.xlarge
instance_type_family	string	O nome da família de instâncias ECS à qual o nó pertence.	ecs.c5
ip_address	array	Os endereços IP do nó.
	string	O endereço IP.	192.168.xx.xx
is_aliyun_node	boolean	Indica se o nó é uma instância da Alibaba Cloud. Valores válidos: `true`: O nó é uma instância da Alibaba Cloud. `false`: O nó não é uma instância da Alibaba Cloud.	true
node_name	string	O nome do nó, que é o identificador do nó dentro do cluster.	cn-chengdu.192.168xx.xx
node_status	string	Indica se o nó está pronto. Valores válidos: `Ready`: O nó está pronto. `NotReady`: O nó não está pronto. `Unknown`: O status do nó é desconhecido. `Offline`: O nó está offline.	Ready
nodepool_id	string	O ID do pool de nós.	np0794239424a84eb7a95327369d56****
source	string	O método usado para inicializar o nó, como criação manual ou criação por ROS.	ess
state	string	O status de execução do nó. Valores válidos: `pending`: sendo criado. `running`: em execução. `starting`: sendo iniciado. `stopping`: sendo parado. `stopped`: parado.	running
spot_strategy	string	O tipo de instância spot. Valores válidos: NoSpot: uma instância não spot. SpotWithPriceLimit: uma instância spot com limite de preço. SpotAsPriceGo: uma instância spot com preço de mercado.	NoSpot
page	object	As informações de paginação.
page_number	integer	O número da página atual.	1
page_size	integer	O número máximo de registros que podem ser exibidos por página.	10
total_count	integer	O número total de resultados.	5

Exemplos

Resposta de sucesso

JSON formato

{
  "nodes": [
    {
      "creation_time": "2025-04-16T07:28:00Z",
      "error_message": "error***",
      "expired_time": "2099-12-31T15:59:00Z",
      "host_name": "iZ2vcckdmxp7u0urj2k****",
      "image_id": "aliyun_3_x64_20G_alibase_20241218.vhd",
      "instance_charge_type": "PostPaid",
      "instance_id": "i-2vcckdmxp7u0urj2****",
      "instance_name": "worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****",
      "instance_role": "Worker",
      "instance_status": "Running",
      "instance_type": "ecs.c5.xlarge",
      "instance_type_family": "ecs.c5",
      "ip_address": [
        "192.168.xx.xx"
      ],
      "is_aliyun_node": true,
      "node_name": "cn-chengdu.192.168xx.xx",
      "node_status": "Ready",
      "nodepool_id": "np0794239424a84eb7a95327369d56****",
      "source": "ess",
      "state": "running",
      "spot_strategy": "NoSpot"
    }
  ],
  "page": {
    "page_number": 1,
    "page_size": 10,
    "total_count": 5
  }
}

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.