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

Chama a API ModifyCluster para modificar a configuração de um cluster ACK.

Descrição da operação

Importante

A partir de 4 de julho de 2026, os parâmetros de solicitação instance_deletion_protection, ingress_loadbalancer_id e access_control_list serão descontinuados. Para mais detalhes, consulte Anúncio sobre alterações e descontinuações de parâmetros da OpenAPI de gerenciamento de clusters ACK.

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:ModifyCluster

update

*Cluster

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

cs:EnableApiServerEip
cs:ApiServerEipId

Nenhuma

Sintaxe da solicitação

PUT /api/v2/clusters/{ClusterId} HTTP/1.1

Parâmetros de caminho

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
body	object	Não	Os parâmetros do corpo da solicitação.	true
api_server_eip	boolean	Não	Especifica se um EIP deve ser associado ao API server do cluster para acesso público. Valores válidos: `true`: Associa um EIP ao cluster. `false`: Não associa um EIP ao cluster.	true
api_server_eip_id	string	Não	O ID da instância de EIP a ser associada ao API server do cluster. Este parâmetro entra em vigor somente quando `api_server_eip` está definido como `true`.	eip-wz9fnasl6dsfhmvci****
deletion_protection	boolean	Não	Especifica se a proteção contra exclusão deve ser ativada para o cluster. Isso impede que o cluster seja excluído acidentalmente pelo console ou por uma operação de API. Valores válidos: `true`: Ativa a proteção contra exclusão. O cluster não pode ser excluído pelo console ou por uma operação de API. `false`: Desativa a proteção contra exclusão. O cluster pode ser excluído pelo console ou por uma operação de API. Valor padrão: `false`.	false
resource_group_id	string	Não	O ID do grupo de recursos ao qual o cluster pertence.	rg-acfmyvw3wjm****
maintenance_window	maintenance_window	Não	A janela de manutenção do cluster. Este recurso está disponível apenas para clusters gerenciados ACK Pro.
enable_rrsa	boolean	Não	Especifica se o recurso RRSA deve ser ativado. Este parâmetro está disponível apenas para clusters gerenciados. Valores válidos: `true`: Ativa o recurso RRSA. `false`: Desativa o recurso RRSA.	true
cluster_name	string	Não	O nome do cluster. O nome deve ter de 1 a 63 caracteres. Pode conter dígitos, letras, caracteres chineses e hifens (-), mas não pode começar com um hífen.	cluster-new-name
cluster_spec	string	Não	A especificação do cluster. Este parâmetro está disponível apenas quando `cluster_type` está definido como `ManagedKubernetes` e o parâmetro `profile` está configurado. Valores válidos: `ack.pro.small`: Edição Pro `ack.pro.xlarge`: Pro XL `ack.pro.2xlarge`: Pro 2XL `ack.pro.4xlarge`: Pro 4XL (Esta edição está disponível apenas para usuários na lista de permissões.) Este recurso pré-aloca recursos do plano de controle para garantir concorrência de API e agendamento de Pods consistentes e de alto desempenho. É ideal para cargas de trabalho de IA, clusters de escala ultra grande e aplicações de missão crítica. Para mais informações sobre as taxas de gerenciamento de clusters da edição Pro e clusters com plano de controle provisionado, consulte Taxas de gerenciamento de cluster.	ack.pro.small
system_events_logging	object	Não	Configurações para armazenamento de eventos do sistema.
enabled	boolean	Não	Especifica se o armazenamento de eventos do sistema deve ser ativado. Valores válidos: `true`: Ativa o armazenamento de eventos do sistema. false: Não armazena eventos do sistema.	true
logging_project	string	Não	O nome do LogProject para armazenamento de eventos do sistema.	k8s-log-cb95aa626a47740afbf6aa099b65****
operation_policy	object	Não	A política de O&M automatizada do cluster.
cluster_auto_upgrade	object	Não	A política de atualização automática do cluster.
enabled	boolean	Não	Whether to enable cluster automatic upgrade. true: Enable automatic upgrade. false: Disable automatic upgrade.	true
channel	string	Não	Cluster automatic upgrade frequency. For more information, see Upgrade Frequency. Valid values: patch: Latest patch version. stable: Second latest minor version. rapid: Latest minor version.	patch
api_server_custom_cert_sans	object	Não	Os Subject Alternative Names (SANs) personalizados para o certificado do API server. Isso permite que os clientes acessem o API server usando endereços IP ou nomes de domínio personalizados. Este parâmetro está disponível apenas para clusters gerenciados.
action	string	Não	A ação a ser executada na configuração de SAN. Valores válidos: overwrite: Substitui a configuração de SAN existente. append: Adiciona à configuração de SAN existente.	append
subject_alternative_names	array	Não	A lista de SANs.
	string	Não	Um único SAN. Pode ser um endereço IP personalizado ou um nome de domínio.	aliyun.xxx.com,192.168.xx.xx
vswitch_ids	array	Não	Os VSwitches do plano de controle. Para um cluster dedicado, essa alteração afeta apenas os nós do plano de controle recém-adicionados. Ao alterar os VSwitches de um cluster gerenciado, observe os seguintes itens: Este parâmetro substitui a lista de VSwitches existente. Você deve especificar a lista completa dos VSwitches de destino. Os componentes do plano de controle serão reiniciados brevemente durante a atualização. Recomendamos realizar esta operação fora dos horários de pico. Certifique-se de que as regras de entrada e saída de todos os grupos de segurança no cluster (incluindo o grupo de segurança do plano de controle, grupos de segurança de todos os pools de nós e grupos de segurança usados pela rede de contêineres) permitam tráfego dos blocos CIDR de IP dos novos VSwitches. Caso contrário, os nós e contêineres podem falhar ao se conectar ao API server. Se você configurar uma lista de controle de acesso (ACL) para os novos VSwitches do plano de controle, certifique-se de que a ACL permita a comunicação com os blocos CIDR de IP dos nós do cluster e da rede de contêineres.
	string	Não	Um VSwitch para o plano de controle.	vsw-2ze4jvvvade1yk899****
control_plane_config	object	Não	As configurações do plano de controle para um cluster dedicado.
charge_type	string	Não	O método de cobrança das instâncias de nós do plano de controle. Valores válidos: `PrePaid`: Assinatura. `PostPaid`: Pay-As-You-Go. Valor padrão: `PostPaid`.	PostPaid
period	integer	Não	A duração da assinatura das instâncias de nós do plano de controle. Este parâmetro é obrigatório apenas se `charge_type` estiver definido como `PrePaid`. Se `period_unit=Month`, os valores válidos são 1, 2, 3, 6, 12, 24, 36, 48 e 60.	1
period_unit	string	Não	O ciclo de cobrança das instâncias de nós do plano de controle. Este parâmetro é obrigatório apenas se `charge_type` estiver definido como `PrePaid`. `Month`: O ciclo de cobrança é mensal. Este é o único valor suportado.	Month
auto_renew	boolean	Não	Especifica se a renovação automática deve ser ativada para as instâncias de nós do plano de controle. Este parâmetro está disponível apenas se `charge_type` estiver definido como `PrePaid`. Valores válidos: `true`: Ativa a renovação automática. `false`: Desativa a renovação automática. Valor padrão: `false`.	false
auto_renew_period	integer	Não	A duração de cada renovação automática para as instâncias de nós do plano de controle. Valores válidos: 1, 2, 3, 6 e 12. Unidade: mês. Valor padrão: 1.	1
instance_types	array	Não	Os tipos de instância. Para mais informações, consulte Família de instâncias.
	string	Não	Um tipo de instância.	ecs.g6.large
image_type	string	Não	O tipo de imagem do SO. Valores válidos: `AliyunLinux3`: Imagem Alinux3. `Custom`: Imagem personalizada.	AliyunLinux3
image_id	string	Não	O ID da imagem personalizada. Este parâmetro é obrigatório se você usar uma imagem personalizada.	aliyun_3_x64_20G_alibase_20240819.vhd
key_pair	string	Não	O nome do key pair. Você deve definir este parâmetro ou `login_password`.	ack
login_password	string	Não	A senha de login SSH para os nós. Você deve especificar este parâmetro ou `key_pair`. A senha deve ter de 8 a 30 caracteres e conter pelo menos três dos seguintes tipos de caracteres: letras maiúsculas, letras minúsculas, dígitos e caracteres especiais. Esta senha é usada para novos nós quando você expande o plano de controle.	Ack@2000.
system_disk_category	string	Não	O tipo do disco do sistema. Valores válidos: `cloud_efficiency`: Ultra Disk. `cloud_ssd`: SSD padrão. `cloud_essd`: ESSD. `cloud_auto`: Disco ESSD AutoPL. `cloud_essd_entry`: Disco ESSD Entry.	cloud_essd
system_disk_size	integer	Não	O tamanho do disco do sistema. Unidade: GiB. Valores válidos: 40 a 500.	120
system_disk_snapshot_policy_id	string	Não	O ID da política de snapshot automático usada para o disco do sistema do nó.	sp-2zej1nogjvovnz4z****
system_disk_performance_level	string	Não	O nível de desempenho do disco do sistema. Este parâmetro está disponível apenas para ESSDs. O nível de desempenho está relacionado ao tamanho do disco. Para mais informações, consulte ESSDs.	PL1
system_disk_provisioned_iops	integer	Não	O IOPS de leitura/gravação provisionado do disco do sistema. Valores válidos: 0 a min{50.000, 1.000 × Capacidade - IOPS Base}. IOPS Base = min{1.800 + 50 × Capacidade, 50.000}. Este parâmetro está disponível apenas quando `system_disk_category` está definido como `cloud_auto`. Para mais informações, consulte Discos ESSD AutoPL.	1000
system_disk_bursting_enabled	boolean	Não	Especifica se o bursting deve ser ativado para o disco do sistema. Valores válidos: `true`: sim `false`: não Este parâmetro está disponível apenas quando `system_disk_category` está definido como `cloud_auto`. Para mais informações, consulte Discos ESSD AutoPL.	true
deploymentset_id	string	Não	O ID do conjunto de implantação.	ds-bp10b35imuam5amw****
cloud_monitor_flags	boolean	Não	Especifica se o agente CloudMonitor deve ser instalado nos nós do plano de controle. Valores válidos: `true`: Instala o agente CloudMonitor. `false`: Não instala o agente CloudMonitor.	true
soc_enabled	boolean	Não	Ativa a proteção de nível 3. Para mais informações, consulte Ativar proteção de nível 3 para um cluster ACK. Valores válidos: `true`: Ativa a proteção de nível 3. `false`: Desativa a proteção de nível 3. Valor padrão: `false`.	false
security_hardening_os	boolean	Não	Especifica se o Alibaba Cloud OS Security Hardening deve ser ativado. Valores válidos: `true`: Ativa o Alibaba Cloud OS Security Hardening. `false`: Desativa o Alibaba Cloud OS Security Hardening. Valor padrão: `false`.	false
cpu_policy	string	Não	A política de gerenciamento de CPU do nó. Para clusters da versão 1.12.6 ou posterior, as seguintes políticas são suportadas: `static`: Permite que pods com características de recurso específicas recebam maior afinidade e exclusividade de CPU no nó. `none`: Indica que o esquema de afinidade de CPU padrão é usado. Valor padrão: `none`.	none
runtime	string	Não	O nome do container runtime. Valores válidos: `containerd`: Recomendado. Suportado por todas as versões de cluster. Valor padrão: containerd.	containerd
node_port_range	string	Não	O intervalo de portas para serviços NodePort. Intervalo válido: 30000 a 65535. Valor padrão: 30000-32767.	30000-32767
size	integer	Não	O número de nós do plano de controle. Para expandir o plano de controle de um cluster dedicado, defina este parâmetro como o número de nós de destino, que deve ser maior que o número atual.	5
security_group_id	string	Não	O ID do grupo de segurança do plano de controle. Se você configurar regras no grupo de segurança para bloquear tráfego, certifique-se de permitir tráfego nas portas e protocolos dos quais o cluster depende. Para mais informações sobre as regras de grupo de segurança recomendadas, consulte Configurar e gerenciar grupos de segurança do cluster. Para clusters que não sejam clusters ACK dedicados, o plano de controle e os componentes gerenciados instalados, como terway-controlplane, são reiniciados brevemente durante a atualização. Recomendamos que você realize esta operação fora dos horários de pico. Após a alteração do grupo de segurança do plano de controle, as interfaces de rede elásticas (ENIs) usadas pelo plano de controle e pelos componentes gerenciados instalados são automaticamente adicionadas ao novo grupo de segurança. Para clusters ACK dedicados, o novo grupo de segurança do plano de controle é automaticamente aplicado aos novos nós master após a alteração do grupo de segurança. Os nós do plano de controle existentes não são afetados.	sg-bp1h6rk3pgct2a08***
timezone	string	Não	O fuso horário do cluster. Para mais informações, consulte Fusos horários suportados. Após a alteração do fuso horário, a nova configuração de fuso horário é aplicada ao recurso de inspeção do cluster. Para clusters gerenciados, o plano de controle e os componentes gerenciados instalados, como terway-controlplane, são reiniciados brevemente durante a atualização. Recomendamos que você realize esta operação fora dos horários de pico. Após a alteração do fuso horário, a nova configuração de fuso horário é automaticamente aplicada aos novos nós. Os nós existentes não são afetados. Você pode redefinir os nós no pool de nós para aplicar a nova configuração a eles. Para clusters dedicados, após a alteração do fuso horário, a nova configuração de fuso horário é automaticamente aplicada aos novos nós, incluindo nós do plano de controle. Os nós existentes, incluindo nós do plano de controle, não são afetados. Você pode redefinir os nós em um pool de nós para aplicar a nova configuração a eles. Para nós do plano de controle, você deve expandir e depois reduzir os nós para aplicar a nova configuração a todos os nós do plano de controle.	Asia/Shanghai
control_plane_endpoints_config	object	Não	As configurações de conexão do cluster.
internal_dns_config	object	Não	As configurações de nome de domínio interno do cluster. Este parâmetro está disponível apenas para clusters gerenciados ACK. O nome de domínio interno é usado por componentes do sistema no lado do nó, como kubelet e kube-proxy, para acessar o API server. Se você não ativar o acesso ao cluster por meio de um nome de domínio interno, os componentes do sistema no lado do nó acessam o API server usando o endereço IP do CLB.
bind_vpcs	array	Não	VPCs where the cluster internal domain name record resolution takes effect.
	string	Não	VPCs where the cluster internal domain name record resolution takes effect.	vpc-xxxx
enabled	boolean	Não	Whether to enable cluster internal domain name access. Valid values: true: Enable cluster internal domain name access. Node-side components (kubelet, kube-proxy) will access the API Server through the cluster internal domain name.	true
access_control_list `deprecated`	array	Não	A lista de controle de acesso (ACL) da instância SLB usada pelo API server de um cluster registrado.
	string	Não	A lista de controle de acesso (ACL) da instância SLB usada pelo API server de um cluster registrado. Nota Não especifique 0.0.0.0/0.	192.168.XX.XX/24
instance_deletion_protection `deprecated`	boolean	Não	Especifica se a proteção contra exclusão deve ser ativada para os nós, a fim de evitar que sejam excluídos por engano no console ou por meio de uma operação de API. Valores válidos: `true`: Você não pode excluir nós por engano no console ou por meio de uma operação de API. `false`: Você pode excluir nós por engano no console ou por meio de uma operação de API. Valor padrão: `false`.	false
ingress_domain_rebinding `deprecated`	boolean	Não	Especifica se o domínio de teste do cluster deve ser reassociado. Valores válidos: `true`: Reassocia o domínio de teste do cluster. `false`: Não reassocia o domínio de teste do cluster. Valor padrão: `false`.	false
ingress_loadbalancer_id `deprecated`	string	Não	O ID da instância SLB associada ao cluster a ser modificado.	lb-wz97kes8tnndkpodw****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
cluster_id	string	O ID do cluster.	cb95aa626a47740afbf6aa09****
request_id	string	O ID da solicitação.	687C5BAA-D103-4993-884B-C35E4314****
task_id	string	O ID da tarefa.	T-5a54309c80282e39ea00****

Exemplos

Resposta de sucesso

JSON formato

{
  "cluster_id": "cb95aa626a47740afbf6aa09****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****",
  "task_id": "T-5a54309c80282e39ea00****"
}

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.