Consultar nós em 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 códigos de exemplo da operação para diferentes SDKs.

Sintaxe da solicitação

GET /clusters/ClusterId/nodes?instanceIds=String&nodepool_id=String&state=String&pageSize=String&pageNumber=String HTTP/1.1
Content-Type:application/json

Parâmetros da solicitação

Tabela 1. Parâmetros de caminho da solicitação
Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
ClusterId	String	Sim	c82e6987e2961451182edacd74faf****	ID do cluster a ser consultado.

Tabela 2. Parâmetros de consulta da solicitação
Parâmetro	Tipo	Obrigatório	Exemplos	Descrição
instanceIds	String	Não	"i-bp11xjhwkj8k966u**,i-bp1dmhc2bu5igkyq**"	IDs dos nós a serem consultados. Separe vários IDs de nó com vírgulas (,).
nodepool_id	String	Não	np****	ID do pool de nós.
state	String	Não	running	Estado do nó usado para filtragem. Valores válidos: `all`: consulta nós nos quatro estados a seguir. `running`: consulta nós em execução. `removing`: consulta nós em processo de remoção. `initial`: consulta nós em inicialização. `failed`: consulta nós cuja criação falhou. Valor padrão: `all`.
pageSize	String	Não	10	Número de entradas a retornar por página. Valores válidos: 1 a 100. Valor padrão: 10.
pageNumber	String	Não	1	Número da página a retornar. Valor padrão: 1.

Sintaxe da resposta

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

{
  "nodes" : [ {
    "creation_time" : "String",
    "error_message" : "String",
    "expired_time" : "String",
    "host_name" : "String",
    "image_id" : "String",
    "instance_charge_type" : "String",
    "instance_id" : "String",
    "instance_name" : "String",
    "instance_role" : "String",
    "instance_status" : "String",
    "instance_type" : "String",
    "instance_type_family" : "String",
    "ip_address" : [ "String" ],
    "is_aliyun_node" : Boolean,
    "node_name" : "String",
    "node_status" : "String",
    "nodepool_id" : "String",
    "source" : "String",
    "state" : "String"
  } ],
  "page" : {
    "page_number" : Integer,
    "page_size" : Integer,
    "total_count" : Integer
  }
}

Parâmetros da resposta

Tabela 3. Parâmetros do corpo da resposta
Parâmetro	Tipo	Exemplo	Descrição
nodes	Array of node		Detalhes dos nós retornados.
creation_time	String	2020-08-25T11:25:35+08:00	Horário de criação do nó.
error_message	String	error***	Mensagem de erro gerada durante a criação do nó.
expired_time	String	2099-12-31T23:59:00+08:00	Data de expiração do nó.
host_name	String	iZ2vcckdmxp7u0urj2k****	Nome do host.
image_id	String	aliyun_2_1903_x64_20G_alibase_20200529.vhd	ID da imagem de sistema usada pelo nó.
instance_charge_type	String	PostPaid	Método de faturamento da instância onde o nó está implantado. Valores válidos: `PrePaid`: método de faturamento por assinatura. Se o valor for PrePaid, verifique se há saldo ou crédito suficiente na conta. Caso contrário, o sistema retorna o erro `InvalidPayMethod`. `PostPaid`: método de pagamento conforme o uso.
instance_id	String	i-2vcckdmxp7u0urj2****	ID da instância onde o nó está implantado.
instance_name	String	worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****	Nome da instância onde o nó está implantado.
instance_role	String	Worker	Função do nó. Valores válidos: Master: nó mestre Worker: nó worker
instance_status	String	Running	Status atual do nó.
instance_type	String	ecs.c5.xlarge	Tipo de instância do nó.
instance_type_family	String	ecs.c5	Família de instâncias do Elastic Compute Service (ECS) do nó.
ip_address	Array of String	192.168.0.36	Endereço IP do nó.
is_aliyun_node	Boolean	true	Indica se a Alibaba Cloud forneceu a instância onde o nó está implantado. Valores válidos: `true`: A instância é fornecida pela Alibaba Cloud. `false`: A instância não é fornecida pela Alibaba Cloud.
node_name	String	cn-chengdu.192.168.0.36	Nome do nó. Este nome identifica o nó no cluster.
node_status	String	Ready	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.
nodepool_id	String	np0794239424a84eb7a95327369d56****	ID do pool de nós.
source	String	ess_attach	Indica como o nó foi inicializado. Um nó pode ser criado manualmente ou pelo Resource Orchestration Service (ROS).
state	String	running	Estado operacional do nó. Valores válidos: `pending`: O nó está sendo criado. `running`: O nó está em execução. `starting`: O nó está iniciando. `stopping`: O nó está parando. `stopped`: O nó está parado.
spot_strategy	String	NoSpot	Tipo da instância preemptível. Valores válidos: NoSpot: instância não preemptível. SpotWithPriceLimit: instância preemptível configurada com preço máximo de lance. SpotAsPriceGo: instância preemptível cujo lance é definido automaticamente pelo sistema com base no preço de mercado atual.
page	Object		Detalhes de paginação.
page_number	Integer	1	Número da página retornada.
page_size	Integer	10	Quantidade de entradas retornadas por página.
total_count	Integer	5	Total de entradas retornadas.

Exemplos

Exemplos de solicitações

GET /clusters/c82e6987e2961451182edacd74faf****/nodes?instanceIds="i-bp11xjhwkj8k966u****,i-bp1dmhc2bu5igkyq****"&nodepool_id=np****&state=running&pageSize=3&pageNumber=50 HTTP/1.1
Host:cs.aliyuncs.com
Content-Type:application/json

Exemplos de respostas de sucesso

Formato XML

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

<DescribeClusterNodesResponse>
    <nodes>
        <creation_time>2020-08-25T11:25:35+08:00</creation_time>
        <error_message>error***</error_message>
        <expired_time>2099-12-31T23:59:00+08:00</expired_time>
        <host_name>iZ2vcckdmxp7u0urj2k****</host_name>
        <image_id>aliyun_2_1903_x64_20G_alibase_20200529.vhd</image_id>
        <instance_charge_type>PostPaid</instance_charge_type>
        <instance_id>i-2vcckdmxp7u0urj2****</instance_id>
        <instance_name>worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****</instance_name>
        <instance_role>Worker</instance_role>
        <instance_status>Running</instance_status>
        <instance_type>ecs.c5.xlarge</instance_type>
        <instance_type_family>ecs.c5</instance_type_family>
        <ip_address>192.168.0.36</ip_address>
        <is_aliyun_node>true</is_aliyun_node>
        <node_name>cn-chengdu.192.168.0.36</node_name>
        <node_status>Ready</node_status>
        <nodepool_id>np0794239424a84eb7a95327369d56****</nodepool_id>
        <source>ess_attach</source>
        <state>running</state>
    </nodes>
    <page>
        <page_number>1</page_number>
        <page_size>10</page_size>
        <total_count>5</total_count>
    </page>
</DescribeClusterNodesResponse>

Formato JSON

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

{
  "nodes" : [ {
    "creation_time" : "2020-08-25T11:25:35+08:00",
    "error_message" : "error***",
    "expired_time" : "2099-12-31T23:59:00+08:00",
    "host_name" : "iZ2vcckdmxp7u0urj2k****",
    "image_id" : "aliyun_2_1903_x64_20G_alibase_20200529.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.0.36" ],
    "is_aliyun_node" : true,
    "node_name" : "cn-chengdu.192.168.0.36",
    "node_status" : "Ready",
    "nodepool_id" : "np0794239424a84eb7a95327369d56****",
    "source" : "ess_attach",
    "state" : "running"
  } ],
  "page" : {
    "page_number" : 1,
    "page_size" : 10,
    "total_count" : 5
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.