DescribeClusterNodePools - ENS - Centro de documentación de Alibaba Cloud

Consulta todos los pools de nodos de un clúster.

Descripción de la operación

Límite de frecuencia por usuario: 100 llamadas por segundo.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ens:DescribeClusterNodePools

list

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ClusterId	string	Sí	Una breve descripción de la estructura.	eck-xxxxxxxx
PageNumber	integer	Sí	El número de página. Las páginas comienzan desde 1.	1
PageSize	integer	Sí	El número de entradas por página.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
NodePools	array<object>	La lista de pools de nodos.
	array<object>
ClusterId	string	El ID del clúster.	eck-xxxxxxxx
Created	string	La hora de creación.	2026-09-01T00:00:00+08:00
KubernetesConfig	object	Las configuraciones relacionadas con Kubernetes.
PreUserData	string	El script que se ejecuta después de crear la instancia y antes de agregarla al clúster. El contenido debe estar codificado en Base64.	ZWNobyBvawo=
UserData	string	El script que se ejecuta después de crear la instancia y agregarla al clúster. El contenido debe estar codificado en Base64.	ZWNobyBvawo=
NodepoolInfo	object	La información del pool de nodos.
EnsRegionId	string	El ID de la zona perimetral de ENS.	cn-fuzhou-23
Name	string	El nombre del pool de nodos.	eck-node-pool-1
NodepoolId	string	El ID del pool de nodos.	np68mi5y1dd748ky37ojo2kqdrz
ScalingGroup	object	El grupo de escalado.
DataDisks	array<object>	La lista de discos en la nube de datos. Los límites de los parámetros son los mismos que los del disco en la nube del sistema.
	object	La lista de discos en la nube de datos. Los límites de los parámetros son los mismos que los del disco en la nube del sistema.
Category	string	La categoría del disco en la nube.	cloud_efficiency
Size	integer	El tamaño del disco en la nube. Unidad: GB.	80
ImageId	string	El ID de la imagen.	m-673f5z4h69ibwtallg6zmcaxr
InstanceChargeType	string	El método de facturación de la instancia.	PrePaid
InstanceTypes	array	La lista de tipos de instancia.
	string	La lista de tipos de instancia.	ens.sn1.small
KeyPairName	string	El nombre del par de claves.	key-pair-name
Password	string	La contraseña de la instancia.	************
SystemDiskCategory	string	La categoría del disco en la nube del sistema del nodo. Valores válidos: local_ssd, cloud_ssd, cloud_efficiency y local_hdd.	cloud_efficiency
SystemDiskSize	integer	El tamaño del disco en la nube del sistema para el nodo.	80
VswitchIds	array	El ID del vSwitch.
	string	El ID del vSwitch.	vsw-58eu2p6v64qw8ihhit1wz7wgv
Status	object	El estado del pool de nodos.
DesiredNodes	integer	El número esperado de instancias.	10
FailedNodes	integer	El número de nodos que no se pudieron crear en el pool de nodos.	0
InitialNodes	integer	El número de instancias que se están creando.	0
RemovingNodes	integer	El número de instancias que se están eliminando.	0
ServingNodes	integer	El número de instancias en uso.	10
State	string	El estado del pool de nodos. active: Se ha alcanzado el estado deseado. scaling: Escalado horizontal. removing_nodes: Reducción de escala.	active
TotalNodes	integer	El número total de instancias, incluidas las que se están creando, las que están en uso y las que se están eliminando.	10
Page	object	El número de página actual.
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas por página especificado en la solicitud.	10
TotalCount	integer	El número total de entradas.	20
RequestId	string	El ID de la solicitud.	F3B261DD-3858-4D3C-877D-303ADF374600

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.