DescribeClusterNodePools - ENS: Central de Documentação do Alibaba Cloud

Lista todos os pools de nós em um cluster.

Descrição da operação

Frequência de chamadas por usuário único: 100 chamadas por segundo.

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

ens:DescribeClusterNodePools

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Sim	O ID do cluster.	eck-xxxxxxxx
PageNumber	integer	Sim	O número da página a ser retornada. As páginas são numeradas a partir de 1.	1
PageSize	integer	Sim	O número de entradas a serem retornadas por página.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
Page	object	Os detalhes de paginação.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas retornadas por página.	10
TotalCount	integer	O número total de entradas.	20
NodePools	array<object>	A lista de pools de nós.
	array<object>
NodepoolInfo	object	Os detalhes do pool de nós.
Name	string	The name of the node pool.	eck-node-pool-1
EnsRegionId	string	The ID of the ENS node.	cn-fuzhou-23
NodepoolId	string	The ID of the node pool.	np68mi5y1dd748ky37ojo2kqdrz
ScalingGroup	object	A configuração do grupo de dimensionamento.
VswitchIds	array	The IDs of the vSwitches.
	string	The ID of a vSwitch.	vsw-58eu2p6v64qw8ihhit1wz7wgv
InstanceChargeType	string	The billing method of the instances.	PrePaid
InstanceTypes	array	The list of instance types.
	string	The instance type.	ens.sn1.small
SystemDiskCategory	string	The category of the system disk. Valid values: `local_ssd`, `cloud_ssd`, `cloud_efficiency`, and `local_hdd`.	cloud_efficiency
SystemDiskSize	integer	The size of the system disk, in GB.	80
ImageId	string	The ID of the image.	m-673f5z4h69ibwtallg6zmcaxr
KeyPairName	string	The name of the key pair.	key-pair-name
DataDisks	array<object>	The list of data disks. The parameter constraints are the same as those for the system disk.
	object	A data disk.
Category	string	The category of the data disk.	cloud_efficiency
Size	integer	The size of the data disk, in GB.	80
Password	string	The password for the instances.	************
KubernetesConfig	object	A configuração do Kubernetes.
PreUserData	string	The user data script to run on nodes before they are added to the cluster. The script must be Base64-encoded.	ZWNobyBvawo=
UserData	string	The user data script to run on nodes after they are added to the cluster. The script must be Base64-encoded.	ZWNobyBvawo=
Status	object	O status do pool de nós.
State	string	The state of the node pool. Valid values: `active`: The node pool is active. `scaling`: The node pool is scaling out. `removing_nodes`: The node pool is scaling in.	active
TotalNodes	integer	The total number of instances, including those that are being created, in service, or being removed.	10
DesiredNodes	integer	The expected number of instances.	10
ServingNodes	integer	The number of instances in service.	10
InitialNodes	integer	The number of instances that are being created.	0
RemovingNodes	integer	The number of instances that are being removed.	0
FailedNodes	integer	The number of failed instances.	0
ClusterId	string	O ID do cluster.	eck-xxxxxxxx
RequestId	string	O ID da solicitação.	F3B261DD-3858-4D3C-877D-303ADF374600

Exemplos

Resposta de sucesso

JSON formato

{
  "Page": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 20
  },
  "NodePools": [
    {
      "NodepoolInfo": {
        "Name": "eck-node-pool-1",
        "EnsRegionId": "cn-fuzhou-23",
        "NodepoolId": "np68mi5y1dd748ky37ojo2kqdrz"
      },
      "ScalingGroup": {
        "VswitchIds": [
          "vsw-58eu2p6v64qw8ihhit1wz7wgv"
        ],
        "InstanceChargeType": "PrePaid",
        "InstanceTypes": [
          "ens.sn1.small"
        ],
        "SystemDiskCategory": "cloud_efficiency",
        "SystemDiskSize": 80,
        "ImageId": "m-673f5z4h69ibwtallg6zmcaxr",
        "KeyPairName": "key-pair-name",
        "DataDisks": [
          {
            "Category": "cloud_efficiency",
            "Size": 80
          }
        ],
        "Password": "************"
      },
      "KubernetesConfig": {
        "PreUserData": "ZWNobyBvawo=",
        "UserData": "ZWNobyBvawo="
      },
      "Status": {
        "State": "active",
        "TotalNodes": 10,
        "DesiredNodes": 10,
        "ServingNodes": 10,
        "InitialNodes": 0,
        "RemovingNodes": 0,
        "FailedNodes": 0
      },
      "ClusterId": "eck-xxxxxxxx"
    }
  ],
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600"
}

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.