Chame a operação DescribeClusterNodePools para consultar os node pools em um cluster do Container Service for Kubernetes (ACK).
Depuração
Cabeçalhos da requisição
Esta operação utiliza apenas cabeçalhos de requisição comuns. Para mais informações, consulte Cabeçalhos de requisição comuns.
Sintaxe da requisição
GET /clusters/{ClusterId}/nodepools HTTP/1.1
Parâmetros da requisição
|
Parâmetro |
Tipo |
Posição |
Obrigatório |
Exemplo |
Descrição |
|
ClusterId |
String |
Path |
Sim |
cc0f87de0b8fb403f86e10e204f83**** |
O ID do cluster. |
Parâmetros de resposta
Parâmetro |
Tipo |
Exemplo |
Descrição |
| nodepools | Array | A lista dos node pools retornados. |
|
| auto_scaling | Object | As configurações de auto scaling. |
|
| eip_bandwidth | Long | 5 | A largura de banda máxima do elastic IP address (EIP) associado ao node pool. |
| is_bond_eip | Boolean | true | Indica se um EIP está associado ao node pool. Valores válidos:
|
| eip_internet_charge_type | String | PayByBandwidth | O método de faturamento do EIP. Valores válidos:
|
| enable | Boolean | true | Indica se o auto scaling está ativado.
|
| max_instances | Long | 10 | O número máximo de instâncias do Elastic Compute Service (ECS) que podem ser criadas no node pool. |
| min_instances | Long | 2 | O número mínimo de instâncias ECS que devem ser mantidas no node pool. |
| type | String | cpu | Os tipos de instância que podem ser usados para o auto scaling do node pool. Valores válidos:
|
| kubernetes_config | Object | As configurações do cluster onde o node pool está implantado. |
|
| cms_enabled | Boolean | true | Indica se o agente do CloudMonitor está instalado nos nós ECS do cluster. Após a instalação do agente do CloudMonitor, é possível visualizar informações de monitoramento sobre as instâncias ECS no console do CloudMonitor. A instalação é recomendada. Valores válidos:
|
| cpu_policy | String | none | A política de gerenciamento de CPU dos nós em um node pool. As seguintes políticas são suportadas se a versão do Kubernetes do cluster for 1.12.6 ou posterior.
|
| labels | Array of tag | Os rótulos dos nós no node pool. É possível adicionar rótulos aos nós no cluster. Adicione rótulos seguindo as regras abaixo:
|
|
| runtime | String | docker | O nome do runtime de contêiner. |
| runtime_version | String | 19.03.5 | A versão do runtime de contêiner. |
| taints | Array of taint | Os taints dos nós. Taints são adicionados aos nós para impedir que pods sejam agendados em nós inadequados. No entanto, tolerations permitem que pods sejam agendados em nós com taints correspondentes. Para mais informações, consulte Taints e Tolerations. |
|
| user_data | String | IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD**** | Os dados de usuário do node pool. Para mais informações, consulte Gerar dados de usuário. |
| node_name_mode | String | customized,test.,5,.com | Um nome de nó personalizado consiste em um prefixo, uma substring de IP e um sufixo.
Por exemplo, se o endereço IP do nó for 192.168.0.55, o prefixo for aliyun.com, o comprimento da substring de IP for 5 e o sufixo for test, o nome do nó será aliyun.com00055test. |
| nodepool_info | Object | As informações sobre o node pool. |
|
| created | String | 2020-09-27T19:14:09.156823496+08:00 | O horário em que o node pool foi criado. |
| is_default | Boolean | true | Indica se o node pool é um node pool padrão. Um cluster do Container Service geralmente possui apenas um node pool padrão. Valores válidos:
|
| name | String | default-nodepool | O nome do node pool. O nome deve ter de 1 a 63 caracteres e pode conter dígitos, letras e hifens (-). Não pode começar com um hífen (-). |
| nodepool_id | String | np615c0e0966124216a0412e10afe0**** | O ID do node pool criado. |
| region_id | String | cn-beijing | O ID da região. |
| resource_group_id | String | rg-acfmyvw3wjm**** | O ID do grupo de recursos ao qual o node pool pertence. |
| type | String | ess | O tipo do node pool. Valores válidos:
|
| updated | String | 2020-09-27T20:37:46+08:00 | O horário da última atualização do node pool. |
| scaling_group | Object | A configuração do grupo de dimensionamento. |
|
| auto_renew | Boolean | false | Indica se a renovação automática está ativada para os nós no node pool. Este parâmetro só tem efeito quando
|
| auto_renew_period | Long | 0 | A duração da renovação automática. Este parâmetro tem efeito e é obrigatório apenas quando Se você especificar |
| data_disks | Array of data_disk | As configurações dos discos de dados anexados aos nós no node pool. As configurações incluem o tipo e o tamanho do disco. |
|
| image_id | String | aliyun_2_1903_x64_20G_alibase_20200529.vhd | O ID da imagem personalizada. Chame |
| instance_charge_type | String | PostPaid | O método de faturamento dos nós em um node pool. Valores válidos:
|
| instance_types | Array of String | ecs.n4.large | Os tipos de instância dos nós no node pool. |
| multi_az_policy | String | COST_OPTIMIZED | A política de dimensionamento de instâncias ECS para um grupo de dimensionamento multizona. Valores válidos:
|
| on_demand_base_capacity | Long | 0 | O número mínimo de instâncias de pagamento conforme o uso que devem ser mantidas no grupo de dimensionamento. Valores válidos: 0 a 1000. Se o número de instâncias de pagamento conforme o uso for menor que o valor deste parâmetro, o Auto Scaling cria preferencialmente instâncias de pagamento conforme o uso. |
| on_demand_percentage_above_base_capacity | Long | 20 | A porcentagem de instâncias de pagamento conforme o uso entre as instâncias extras que excedem o número especificado por |
| spot_instance_pools | Long | 5 | O número de tipos de instância disponíveis. O Auto Scaling cria instâncias preemptíveis de múltiplos tipos de instância disponíveis com o menor custo. Valores válidos: 1 a 10 |
| spot_instance_remedy | Boolean | false | Indica se instâncias preemptíveis são suplementadas quando o número de instâncias preemptíveis cai abaixo do número mínimo especificado. Se este parâmetro for definido como true, quando o grupo de dimensionamento receber uma mensagem do sistema informando que uma instância preemptível será recuperada, o grupo tentará criar uma nova instância para substituir esta instância. Valores válidos:
|
| compensate_with_on_demand | Boolean | true | Indica se instâncias de pagamento conforme o uso são criadas automaticamente para atender ao número necessário de instâncias ECS caso instâncias preemptíveis não possam ser criadas devido a motivos como custo ou estoque insuficiente. Este parâmetro só tem efeito quando
|
| period | Long | 1 | A duração da assinatura dos nós no node pool. Este parâmetro tem efeito e é obrigatório apenas quando você define Se você especificar |
| period_unit | String | Month | O ciclo de faturamento dos nós. Este parâmetro só tem efeito quando Valor válido: |
| platform | String | AliyunLinux | A versão de lançamento do sistema operacional. Valores válidos:
|
| ram_policy | String | KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e**** | O nome da função RAM (Resource Access Management) do worker. A função RAM é atribuída aos nós workers do cluster para permitir que eles gerenciem instâncias ECS. |
| spot_strategy | String | NoSpot | O tipo de instância preemptível. Valores válidos:
Para mais informações, consulte Instâncias preemptíveis. |
| spot_price_limit | Array | As configurações de lance das instâncias preemptíveis. |
|
| instance_type | String | ecs.c6.large | O tipo de instância das instâncias preemptíveis. |
| price_limit | String | 0.39 | O limite de preço de uma única instância preemptível. Unidade: USD/hora. |
| rds_instances | Array of String | rm-xxx | Os IDs das instâncias do ApsaraDB RDS. |
| scaling_group_id | String | asg-2ze8n5qw4atggut8**** | O ID do grupo de dimensionamento. |
| scaling_policy | String | release | O modo de dimensionamento do grupo de dimensionamento. Valores válidos:
|
| security_group_id | String | sg-2ze1iuk12m2sb4c4**** | O ID do grupo de segurança ao qual o node pool foi adicionado. Se o node pool for adicionado a vários grupos de segurança, o primeiro ID no valor de |
| security_group_ids | Array of String | sg-2ze1iuk12m2sb4c4**** | Os IDs dos grupos de segurança aos quais o node pool foi adicionado. |
| system_disk_category | String | cloud_efficiency | O tipo de disco do sistema. Valores válidos:
|
| system_disk_size | Long | 120 | O tamanho do disco do sistema de um nó. Unidade: GiB. Valores válidos: 20 a 500 |
| system_disk_performance_level | String | PL1 | O nível de desempenho (PL) do disco do sistema que você deseja usar para o nó. Este parâmetro só tem efeito para SSDs aprimorados (ESSDs). |
| tags | Array of tag | Os rótulos que você deseja adicionar às instâncias ECS. Cada chave deve ser única e não pode exceder 128 caracteres. Nem chaves nem valores podem começar com aliyun ou acs:. Nem chaves nem valores podem conter https:// ou http://. |
|
| vswitch_ids | Array of String | vsw-2ze3ds0mdip0hdz8i**** | O ID do vSwitch. |
| login_password | String | ****** | A senha para login SSH. Você deve definir este parâmetro ou o parâmetro Para fins de segurança, a senha retornada é criptografada. |
| key_pair | String | pro-nodepool | O nome do par de chaves. Você deve definir este parâmetro ou o parâmetro Você deve definir |
| internet_charge_type | String | PayByBandwidth | O método de faturamento do endereço IP público do nó. |
| internet_max_bandwidth_out | Long | 10 | A largura de banda de saída máxima do endereço IP público do nó. Unidade: Mbit/s. Valores válidos: 1 a 100. |
| deploymentset_id | String | ds-bp1d19mmbsv3jf6xxxxx | O ID do conjunto de implantação ao qual as instâncias ECS no node pool pertencem. |
| desired_size | Long | 2 | O número esperado de nós no node pool. |
| private_pool_options | Object | As opções de node pool privado. |
|
| id | String | eap-bp67acfmxazb4**** | O ID do pool privado. O ID de um node pool privado é igual ao ID da garantia de elasticidade ou reserva de capacidade para a qual o node pool privado foi gerado. |
| match_criteria | String | Open | O tipo de node pool privado. Este parâmetro especifica o tipo de pool privado que você deseja usar para criar instâncias. Um node pool privado é gerado quando uma garantia de elasticidade ou um serviço de reserva de capacidade entra em vigor. O sistema seleciona um node pool privado para iniciar instâncias. Valores válidos:
|
| status | Object | Os detalhes de status do node pool. |
|
| failed_nodes | Long | 0 | O número de nós com falha. |
| healthy_nodes | Long | 3 | O número de nós íntegros. |
| initial_nodes | Long | 0 | O número de nós que estão sendo criados. |
| offline_nodes | Long | 0 | O número de nós offline. |
| removing_nodes | Long | 0 | O número de nós que estão sendo removidos. |
| serving_nodes | Long | 3 | O número de nós em execução. |
| state | String | active | O status do node pool. Valores válidos:
|
| total_nodes | Long | 3 | O número total de nós no node pool. |
| tee_config | Object | A configuração de computação confidencial. |
|
| tee_enable | Boolean | false | Indica se a computação confidencial está ativada. Valores válidos:
|
| management | Object | As configurações de node pools gerenciados. Node pools gerenciados estão disponíveis apenas em clusters Kubernetes gerenciados profissionais. |
|
| enable | Boolean | true | Indica se o recurso de node pool gerenciado está ativado. Valores válidos:
|
| auto_repair | Boolean | true | Indica se o reparo automático está ativado. Este parâmetro só tem efeito quando
|
| upgrade_config | Object | A configuração de atualização automática. A configuração só tem efeito quando |
|
| auto_upgrade | Boolean | true | Indica se a atualização automática está ativada. Valores válidos:
|
| surge | Long | 5 | O número de nós adicionais. |
| surge_percentage | Long | 50 | A porcentagem de nós adicionais em relação aos nós no node pool. Você deve definir este parâmetro ou Número de nós adicionais = Porcentagem de nós adicionais × Número de nós no node pool. Por exemplo, se a porcentagem de nós adicionais for definida como 50% e o número de nós no node pool for seis, o número de nós adicionais será três. |
| max_unavailable | Long | 1 | O número máximo de nós que podem estar no estado não agendável. Valores válidos: 1 a 1000. Valor padrão: 1. |
| interconnect_config | Object | Este parâmetro foi descontinuado. A configuração de rede do node pool de borda. Este parâmetro só tem efeito para node pools de borda. |
|
| cen_id | String | cen-ey9k9nfhz0f******* | Este parâmetro foi descontinuado. O ID da instância da Cloud Enterprise Network (CEN) associada ao node pool de borda aprimorado. |
| ccn_id | String | ccn-qm5i0i0q9yi******* | Este parâmetro foi descontinuado. O ID da instância da Cloud Connect Network (CCN) associada ao node pool de borda aprimorado. |
| ccn_region_id | String | cn-shanghai | Este parâmetro foi descontinuado. A região à qual pertence a instância CCN associada ao node pool de borda aprimorado. |
| bandwidth | Long | 10 | Este parâmetro foi descontinuado. A largura de banda do node pool de borda aprimorado. Unidade: Mbit/s. |
| improved_period | String | 1 | Este parâmetro foi descontinuado. A duração da assinatura do node pool de borda aprimorado. A duração é medida em meses. |
| interconnect_mode | String | basic | O tipo de rede do node pool de borda. Valores válidos: basic e dedicated. Este parâmetro só tem efeito para node pools de borda. |
| max_nodes | Long | 10 | O número máximo de nós suportados pelo node pool de borda. O valor deste parâmetro deve ser igual ou superior a 0. Um valor 0 indica que o número de nós no node pool é limitado apenas pela cota de nós no cluster. Na maioria dos casos, este parâmetro é definido com um valor maior que 0 para node pools de borda. Este parâmetro é definido como 0 para node pools cujos tipos são ess ou node pools de borda padrão. |
| node_config | Object | As configurações dos nós. |
Exemplos
Exemplos de requisições
GET /clusters/cc0f87de0b8fb403f86e10e204f83****/nodepools HTTP/1.1
Content-Type:application/json
Exemplos de respostas de sucesso
Formato XML
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeClusterNodePoolsResponse>
<nodepools>
<auto_scaling>
<eip_bandwidth>5</eip_bandwidth>
<is_bond_eip>true</is_bond_eip>
<eip_internet_charge_type>PayByBandwidth</eip_internet_charge_type>
<enable>true</enable>
<max_instances>10</max_instances>
<min_instances>2</min_instances>
<type>cpu</type>
</auto_scaling>
<kubernetes_config>
<cms_enabled>true</cms_enabled>
<cpu_policy>none</cpu_policy>
<labels>
<key>env</key>
<value>prod</value>
</labels>
<runtime>docker</runtime>
<runtime_version>19.03.5</runtime_version>
<taints>
<key>key</key>
<value>value</value>
<effect>NoSchedule</effect>
</taints>
<user_data>IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****</user_data>
</kubernetes_config>
<nodepool_info>
<created>2020-09-27T19:14:09.156823496+08:00</created>
<is_default>true</is_default>
<name>default-nodepool</name>
<nodepool_id>np615c0e0966124216a0412e10afe0****</nodepool_id>
<region_id>cn-beijing</region_id>
<resource_group_id>rg-acfmyvw3wjm****</resource_group_id>
<type>ess</type>
<updated>2020-09-27T20:37:46+08:00</updated>
</nodepool_info>
<scaling_group>
<auto_renew>false</auto_renew>
<auto_renew_period>0</auto_renew_period>
<data_disks>
<category>cloud_ssd</category>
<size>40</size>
<encrypted>true</encrypted>
<auto_snapshot_policy_id>sp-2zej1nogjvovnz4z****</auto_snapshot_policy_id>
</data_disks>
<image_id>aliyun_2_1903_x64_20G_alibase_20200529.vhd</image_id>
<instance_charge_type>PostPaid</instance_charge_type>
<instance_types>ecs.n4.large</instance_types>
<multi_az_policy>COST_OPTIMIZED</multi_az_policy>
<on_demand_base_capacity>0</on_demand_base_capacity>
<on_demand_percentage_above_base_capacity>20</on_demand_percentage_above_base_capacity>
<spot_instance_pools>5</spot_instance_pools>
<spot_instance_remedy>false</spot_instance_remedy>
<compensate_with_on_demand>true</compensate_with_on_demand>
<period>0</period>
<period_unit>Month</period_unit>
<platform>AliyunLinux</platform>
<ram_policy>KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****</ram_policy>
<spot_strategy>NoSpot</spot_strategy>
<spot_price_limit>
<instance_type>ecs.c6.large</instance_type>
<price_limit>0.39</price_limit>
</spot_price_limit>
<rds_instances>rm-xxx</rds_instances>
<scaling_group_id>asg-2ze8n5qw4atggut8****</scaling_group_id>
<scaling_policy>release</scaling_policy>
<security_group_id>sg-2ze1iuk12m2sb4c4****</security_group_id>
<security_group_ids>sg-2ze1iuk12m2sb4c4****</security_group_ids>
<system_disk_category>cloud_efficiency</system_disk_category>
<system_disk_size>120</system_disk_size>
<tags>
<key>env</key>
<value>prod</value>
</tags>
<vswitch_ids>vsw-2ze3ds0mdip0hdz8i****</vswitch_ids>
<login_password>******</login_password>
<key_pair>pro-nodepool</key_pair>
<internet_charge_type>PayByBandwidth</internet_charge_type>
<internet_max_bandwidth_out>10</internet_max_bandwidth_out>
</scaling_group>
<status>
<failed_nodes>0</failed_nodes>
<healthy_nodes>3</healthy_nodes>
<initial_nodes>0</initial_nodes>
<offline_nodes>0</offline_nodes>
<removing_nodes>0</removing_nodes>
<serving_nodes>3</serving_nodes>
<state>active</state>
<total_nodes>3</total_nodes>
</status>
<tee_config>
<tee_enable>false</tee_enable>
</tee_config>
<management>
<enable>true</enable>
<auto_repair>true</auto_repair>
<upgrade_config>
<auto_upgrade>true</auto_upgrade>
<surge>5</surge>
<surge_percentage>50</surge_percentage>
<max_unavailable>1</max_unavailable>
</upgrade_config>
</management>
</nodepools>
</DescribeClusterNodePoolsResponse>
Formato JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"nodepools" : [ {
"auto_scaling" : {
"eip_bandwidth" : 5,
"is_bond_eip" : true,
"eip_internet_charge_type" : "PayByBandwidth",
"enable" : true,
"max_instances" : 10,
"min_instances" : 2,
"type" : "cpu"
},
"kubernetes_config" : {
"cms_enabled" : true,
"cpu_policy" : "none",
"labels" : [ {
"key" : "env",
"value" : "prod"
} ],
"runtime" : "docker",
"runtime_version" : "19.03.5",
"taints" : [ {
"key" : "key",
"value" : "value",
"effect" : "NoSchedule"
} ],
"user_data" : "IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****"
},
"nodepool_info" : {
"created" : "2020-09-27T19:14:09.156823496+08:00",
"is_default" : true,
"name" : "default-nodepool",
"nodepool_id" : "np615c0e0966124216a0412e10afe0****",
"region_id" : "cn-beijing",
"resource_group_id" : "rg-acfmyvw3wjm****",
"type" : "ess",
"updated" : "2020-09-27T20:37:46+08:00"
},
"scaling_group" : {
"auto_renew" : false,
"auto_renew_period" : 0,
"data_disks" : [ {
"category" : "cloud_ssd",
"size" : 40,
"encrypted" : "true",
"auto_snapshot_policy_id" : "sp-2zej1nogjvovnz4z****"
} ],
"image_id" : "aliyun_2_1903_x64_20G_alibase_20200529.vhd",
"instance_charge_type" : "PostPaid",
"instance_types" : [ "ecs.n4.large" ],
"multi_az_policy" : "COST_OPTIMIZED",
"on_demand_base_capacity" : 0,
"on_demand_percentage_above_base_capacity" : 20,
"spot_instance_pools" : 5,
"spot_instance_remedy" : false,
"compensate_with_on_demand" : true,
"period" : 0,
"period_unit" : "Month",
"platform" : "AliyunLinux",
"ram_policy" : "KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****",
"spot_strategy" : "NoSpot",
"spot_price_limit" : [ {
"instance_type" : "ecs.c6.large",
"price_limit" : "0.39"
} ],
"rds_instances" : [ "rm-xxx" ],
"scaling_group_id" : "asg-2ze8n5qw4atggut8****",
"scaling_policy" : "release",
"security_group_id" : "sg-2ze1iuk12m2sb4c4****",
"security_group_ids" : [ "sg-2ze1iuk12m2sb4c4****" ],
"system_disk_category" : "cloud_efficiency",
"system_disk_size" : 120,
"tags" : [ {
"key" : "env",
"value" : "prod"
} ],
"vswitch_ids" : [ "vsw-2ze3ds0mdip0hdz8i****" ],
"login_password" : "******",
"key_pair" : "pro-nodepool",
"internet_charge_type" : "PayByBandwidth",
"internet_max_bandwidth_out" : 10
},
"status" : {
"failed_nodes" : 0,
"healthy_nodes" : 3,
"initial_nodes" : 0,
"offline_nodes" : 0,
"removing_nodes" : 0,
"serving_nodes" : 3,
"state" : "active",
"total_nodes" : 3
},
"tee_config" : {
"tee_enable" : false
},
"management" : {
"enable" : true,
"auto_repair" : true,
"upgrade_config" : {
"auto_upgrade" : true,
"surge" : 5,
"surge_percentage" : 50,
"max_unavailable" : 1
}
}
} ]
}
Códigos de erro
Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.