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

Modifica 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 não terão mais efeito. Para obter mais informações sobre as alterações, consulte Anúncio sobre alterações nos parâmetros de solicitação e resposta da OpenAPI e descontinuação da OpenAPI para 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
access_control_list `deprecated`	array	Não	A lista de controle de acesso (ACL) para o SLB do servidor de API de um cluster registrado.
	string	Não	A lista de controle de acesso (ACL) para o SLB do servidor de API de um cluster registrado. Nota: O bloco CIDR 0.0.0.0/0 não é permitido.	192.168.XX.XX/24
api_server_custom_cert_sans	object	Não	Os Nomes Alternativos do Assunto (SANs) personalizados do certificado do servidor de API. Este parâmetro adiciona endereços IP ou nomes de domínio personalizados ao campo SAN do certificado do servidor de API do cluster para controle de acesso do cliente. Apenas clusters gerenciados suportam este parâmetro.
action	string	Não	Especifica se deve sobrescrever ou acrescentar a configuração de SAN. Valores válidos: overwrite: sobrescreve a configuração de SAN existente. append: acrescenta à configuração de SAN existente.	append
subject_alternative_names	array	Não	A lista de SANs.
	string	Não	O SAN. Endereços IP ou nomes de domínio personalizados são suportados. Separe vários endereços IP ou nomes de domínio com vírgulas (,).	aliyun.xxx.com,192.168.xx.xx
api_server_eip	boolean	Não	Especifica se o cluster está associado a um EIP para acesso à rede pública ao servidor de API. Valores válidos: `true`: O cluster está associado a um EIP. `false`: O cluster não está associado a um EIP.	true
api_server_eip_id	string	Não	O ID da instância do EIP associado ao servidor de API do cluster. Este parâmetro só entra em vigor quando `api_server_eip` é definido como `true`.	eip-wz9fnasl6dsfhmvci****
client_token	string	Não	O token do cliente.	af31042c-6355-495b-b6e3-exxb9669
cluster_name	string	Não	O nome personalizado do cluster. O nome pode conter dígitos, caracteres chineses, letras e hifens (-). O nome deve ter de 1 a 63 caracteres e não pode começar com um hífen (-).	cluster-new-name
cluster_spec	string	Não	A especificação do cluster quando `cluster_type` é definido como `ManagedKubernetes` e `profile` é configurado. Valores válidos: `ack.pro.small`: Pro `ack.pro.xlarge`: Pro XL `ack.pro.2xlarge`: Pro 2XL `ack.pro.4xlarge`: Pro 4XL (entre em contato com o suporte ao cliente para ser adicionado à lista de permissões) Pro XL, Pro 2XL e Pro 4XL são três níveis fornecidos pelo Plano de controle provisionado do ACK Pro. Ao pré-alocar e dedicar recursos do plano de controle, esses níveis garantem que a simultaneidade da API e os recursos de agendamento de pods permaneçam em um nível consistentemente alto. Eles são adequados para treinamento e inferência de IA, clusters de ultra grande escala e cargas de trabalho de missão crítica. Para obter informações sobre as taxas de gerenciamento de cluster para as edições Pro e plano de controle provisionado, consulte Taxas de gerenciamento de cluster.	ack.pro.small
control_plane_config	object	Não	A configuração do plano de controle para clusters dedicados.
auto_renew	boolean	Não	Especifica se deve ativar a renovação automática para instâncias de nós do plano de controle. Este parâmetro só entra em vigor quando `charge_type` é 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	O período de renovação automática para cada renovação de instâncias de nós do plano de controle. Valores válidos: {1, 2, 3, 6, 12}. Unidade: meses. Valor padrão: 1.	1
charge_type	string	Não	O método de cobrança para instâncias de nós do plano de controle. Valores válidos: `PrePaid`: assinatura. `PostPaid`: pós-pago. Valor padrão: `PostPaid`.	PostPaid
cloud_monitor_flags	boolean	Não	Especifica se deve instalar o agente do CloudMonitor nos nós do plano de controle. Valores válidos: `true`: Instala o agente do CloudMonitor. `false`: Não instala o agente do CloudMonitor.	true
cpu_policy	string	Não	A política de gerenciamento de CPU para nós. As seguintes políticas são suportadas para clusters executando a versão 1.12.6 ou posterior: `static`: Melhora a afinidade e a exclusividade da CPU para pods com características de recursos específicas no nó. `none`: Usa o esquema de afinidade de CPU padrão. Valor padrão: `none`.	none
deploymentset_id	string	Não	O ID do conjunto de implantação.	ds-bp10b35imuam5amw****
image_id	string	Não	O ID da imagem personalizada. Especifique este parâmetro ao usar uma imagem personalizada.	aliyun_3_x64_20G_alibase_20240819.vhd
image_type	string	Não	O tipo de imagem do sistema operacional. Valores válidos: `AliyunLinux3`: imagem Alinux3. `Custom`: imagem personalizada.	AliyunLinux3
instance_types	array	Não	Os tipos de instância. Para obter mais informações, consulte Famílias de instâncias.
	string	Não	O tipo de instância.	ecs.g6.large
key_pair	string	Não	O nome do par de chaves. Especifique este parâmetro ou `login_password`.	ack
login_password	string	Não	A senha de logon SSH. Especifique 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. Para usar o logon baseado em senha, especifique este parâmetro durante o scale-out.	Ack@2000
node_port_range	string	Não	O intervalo de portas de serviço do nó. Intervalo de portas válido: [30000, 65535]. Valor padrão: 30000-32767.	30000-32767
period	integer	Não	A duração da assinatura para instâncias de nós do plano de controle. Este parâmetro entra em vigor e é obrigatório apenas quando `charge_type` é definido como `PrePaid`. Se `period_unit=Month`, os valores válidos são {1, 2, 3, 6, 12, 24, 36, 48, 60}.	1
period_unit	string	Não	A unidade do ciclo de cobrança para instâncias de nós do plano de controle. Este parâmetro só entra em vigor quando `charge_type` é definido como `PrePaid`. `Month`: O ciclo de cobrança é medido em meses. Atualmente, apenas meses são suportados.	Month
runtime	string	Não	O nome do runtime de contêiner. Valores válidos: `containerd`: Recomendado. Suportado por todas as versões do cluster. Valor padrão: containerd.	containerd
security_hardening_os	boolean	Não	Especifica se deve ativar o endurecimento de segurança do Alibaba Cloud OS. Valores válidos: `true`: Ativa o endurecimento de segurança do Alibaba Cloud OS. `false`: Desativa o endurecimento de segurança do Alibaba Cloud OS. Valor padrão: `false`.	false
size	integer	Não	O número de nós do plano de controle. Para fazer o scale-out do plano de controle de um cluster dedicado, defina este parâmetro para o número alvo de nós do plano de controle, que deve ser maior que o número atual.	5
soc_enabled	boolean	Não	Especifica se o reforço de segurança MLPS 2.0 deve ser ativado. Para obter mais informações, consulte Reforço de segurança MLPS 2.0 do ACK na China. Valores válidos: true: Ativa o reforço de segurança MLPS 2.0. false: Desativa o reforço de segurança MLPS 2.0. Valor padrão: false.	false
system_disk_bursting_enabled	boolean	Não	Especifica se o modo burst deve ser ativado para o disco em nuvem do sistema do nó. Valores válidos: true: Ativa o modo burst. false: Desativa o modo burst. Este parâmetro é suportado apenas quando system_disk_category é definido como cloud_auto. Para obter mais informações, consulte Discos em nuvem ESSD AutoPL.	true
system_disk_category	string	Não	O tipo do disco em nuvem do sistema do nó. Valores válidos: cloud_efficiency: disco em nuvem ultra. cloud_ssd: SSD padrão. cloud_essd: ESSD. cloud_auto: disco em nuvem ESSD AutoPL. cloud_essd_entry: disco em nuvem ESSD Entry.	cloud_essd
system_disk_performance_level	string	Não	O nível de desempenho (PL) do disco em nuvem do sistema do nó. Este parâmetro só entra em vigor para discos em nuvem ESSD. O nível de desempenho varia com base no tamanho do disco em nuvem. Para obter mais informações, consulte ESSDs.	PL1
system_disk_provisioned_iops	integer	Não	O IOPS de leitura/gravação provisionado para o disco em nuvem do sistema do nó. Valores válidos: 0 a min{50.000, 1000 × capacidade - desempenho de linha de base}. Desempenho de linha de base = min{1.800 + 50 × capacidade, 50.000}. Este parâmetro é suportado apenas quando system_disk_category é definido como cloud_auto. Para obter mais informações, consulte Discos em nuvem ESSD AutoPL.	1000
system_disk_size	integer	Não	O tamanho do disco em nuvem do sistema do nó. Valores válidos: 40 a 500. Unidade: GiB.	120
system_disk_snapshot_policy_id	string	Não	O ID da política de snapshot automático aplicada ao disco em nuvem do sistema do nó.	sp-2zej1nogjvovnz4z****
control_plane_endpoints_config	object	Não	A configuração de conexão do cluster.
internal_dns_config	object	Não	A configuração de nome de domínio interno do cluster. Este parâmetro se aplica a clusters gerenciados pelo ACK. O nome de domínio interno é usado por componentes do sistema no lado do nó, como kubelet e kube-proxy, para acessar o servidor de API. Se o acesso por nome de domínio interno não estiver ativado, os componentes do sistema no lado do nó acessam o servidor de API por meio do endereço IP do CLB.
bind_vpcs	array	Não	As VPCs nas quais os registros DNS de nome de domínio interno entram em vigor.
	string	Não	As VPCs nas quais os registros DNS de nome de domínio interno entram em vigor.	vpc-xxxx
enabled	boolean	Não	Especifica se o acesso por nome de domínio interno deve ser ativado para o cluster. Valores válidos: true: Ativa o acesso por nome de domínio interno. Os componentes no lado do nó (kubelet, kube-proxy) acessam o servidor de API por meio do nome de domínio interno.	true
load_balancers_config	array<object>	Não	A configuração de balanceamento de carga para acesso ao cluster.
	object	Não	A configuração de balanceamento de carga para acesso ao cluster.
endpoint_type	string	Não	O tipo de endpoint.	public
load_balancer_id	string	Não	A instância SLB associada ao endpoint.	nlb-xxxx
deletion_protection	boolean	Não	Especifica se a proteção contra exclusão deve ser ativada para o cluster. A proteção contra exclusão impede que o cluster seja excluído acidentalmente no console ou por meio de chamadas de operações de API. Valores válidos: true: Ativa a proteção contra exclusão. O cluster não pode ser excluído no console ou por meio de chamadas de operações de API. false: Desativa a proteção contra exclusão. O cluster pode ser excluído no console ou por meio de chamadas de operações de API. Valor padrão: false.	false
enable_rrsa	boolean	Não	Especifica se o recurso RRSA deve ser ativado ou desativado. Apenas clusters gerenciados suportam este parâmetro. Valores válidos: true: Ativar. false: Desativar.	true
ingress_domain_rebinding `deprecated`	boolean	Não	Especifica se o nome de domínio de teste do cluster deve ser revinculado. Valores válidos: true: Revincula o nome de domínio de teste do cluster. false: Não revincula o nome de domínio de teste do cluster. Valor padrão: false.	false
ingress_loadbalancer_id `deprecated`	string	Não	O ID da instância SLB do cluster a ser modificada.	lb-wz97kes8tnndkpodw****
instance_deletion_protection `deprecated`	boolean	Não	Especifica se a proteção contra exclusão de instâncias deve ser ativada para impedir que os nós sejam excluídos acidentalmente no console ou por meio de chamadas de operações de API. Valores válidos: true: Os nós não podem ser excluídos acidentalmente no console ou por meio de chamadas de operações de API. false: Os nós podem ser excluídos no console ou por meio de chamadas de operações de API. Valor padrão: false.	false
maintenance_window	maintenance_window	Não	A configuração da janela de O&M do cluster. Este recurso entra em vigor apenas em clusters gerenciados pelo ACK Pro.
operation_policy	object	Não	A política de O&M automática do cluster.
cluster_auto_upgrade	object	Não	A configuração de atualização automática do cluster.
channel	string	Não	A frequência de atualização automática do cluster. Para mais informações, consulte Frequência de atualização. Valores válidos: patch: A versão de patch mais recente. stable: A segunda versão secundária mais recente. rapid: A versão secundária mais recente.	patch
enabled	boolean	Não	Especifica se a atualização automática do cluster deve ser ativada. true: Ativa a atualização automática. false: Desativa a atualização automática.	true
resource_group_id	string	Não	O ID do grupo de recursos do cluster.	rg-acfmyvw3wjm****
security_group_id	string	Não	O ID do grupo de segurança do plano de controle. Se você configurou regras de bloqueio no grupo de segurança, certifique-se de que as regras do grupo de segurança permitam os protocolos e portas dos quais o cluster depende. Para o escopo recomendado de regras de grupo de segurança, consulte Configurar e gerenciar grupos de segurança do cluster. Para clusters não dedicados do ACK, o plano de controle do cluster e os componentes gerenciados instalados (como o terway-controlplane) são reiniciados brevemente durante o procedimento de alteração. 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 do cluster e pelos componentes gerenciados instalados são adicionadas automaticamente ao novo grupo de segurança. Para clusters dedicados do ACK, após a alteração do grupo de segurança do plano de controle, os novos nós mestre expandidos usam automaticamente o novo grupo de segurança do plano de controle. Os nós existentes do plano de controle não são afetados.	sg-bp1h6rk3pgct2a08***
system_events_logging	object	Não	A configuração de armazenamento de eventos do sistema.
enabled	boolean	Não	Especifica se o armazenamento de eventos do sistema deve ser ativado. true: Ativa o armazenamento de eventos do sistema. false: Desativa o armazenamento de eventos do sistema.	true
logging_project	string	Não	O nome do LogProject para armazenamento de eventos do sistema.	k8s-log-cb95aa626a47740afbf6aa099b65****
timezone	string	Não	O fuso horário do cluster. Consulte Fusos horários suportados. Após a alteração do fuso horário, a configuração de inspeção do cluster utiliza as novas configurações de fuso horário. Para clusters gerenciados, o plano de controle do cluster e os componentes gerenciados instalados (como o terway-controlplane) são reiniciados brevemente durante a alteração. Realize esta operação fora dos horários de pico. Após a alteração do fuso horário, os novos nós adicionados utilizam automaticamente as novas configurações de fuso horário. Os nós existentes não são afetados. Você pode usar o recurso de redefinição de nó do pool de nós para aplicar as novas configurações aos nós existentes. Para clusters dedicados, após a alteração do fuso horário, os novos nós adicionados (incluindo os nós do plano de controle) utilizam automaticamente as novas configurações de fuso horário. Os nós existentes (incluindo os nós do plano de controle) não são afetados. Você pode usar o recurso de redefinição de nó do pool de nós para aplicar as novas configurações aos nós existentes. Para os nós do plano de controle, é necessário expandir e depois reduzir a escala para aplicar as novas configurações a todos os nós do plano de controle.	Asia/Shanghai
vswitch_ids	array	Não	Os vSwitches do plano de controle do cluster. Para clusters dedicados, a alteração se aplica aos novos nós do plano de controle adicionados. Para clusters gerenciados, observe os seguintes itens ao alterar os vSwitches do plano de controle: Este parâmetro realiza uma atualização de substituição completa. Especifique a lista completa de vSwitches de destino. Os componentes do plano de controle são reiniciados brevemente durante a alteração. Prossiga com cautela. Certifique-se de que todos os grupos de segurança do cluster (incluindo o grupo de segurança do plano de controle, os grupos de segurança de todos os pools de nós e os grupos de segurança usados pela rede de contêineres) permitam o tráfego de entrada e saída para os blocos CIDR de IP dos novos vSwitches. Isso impede que nós e contêineres fiquem impossibilitados de se conectar ao servidor de API. Se regras de ACL estiverem configuradas para os novos vSwitches do plano de controle, certifique-se de que as regras de ACL permitam a comunicação com os blocos CIDR de IP dos nós do cluster e da rede de contêineres.
	string	Não	O vSwitch do plano de controle do cluster.	vsw-2ze4jvvvade1yk899****

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.