UpdateIpsecServer - VPN Gateway: Central de Documentação do Alibaba Cloud

Chama a operação UpdateIpsecServer para atualizar a configuração de um servidor IPsec.

Descrição da operação

Se você modificar apenas o IpsecServerName do servidor IPsec, esta operação será síncrona. Se você modificar configurações diferentes de IpsecServerName, esta operação será assíncrona.
Quando UpdateIpsecServer é uma operação assíncrona, o sistema retorna primeiro um ID de solicitação, mas a configuração do servidor IPsec ainda não foi modificada porque a tarefa de modificação ainda está em execução em segundo plano. Você pode chamar DescribeVpnGateway para consultar o status da instância do gateway VPN e determinar o status da modificação da configuração do servidor IPsec:
- Se a instância do gateway VPN estiver no estado updating, a configuração do servidor IPsec está sendo modificada.
- Se a instância do gateway VPN estiver no estado active, a configuração do servidor IPsec foi modificada.
A operação UpdateIpsecServer não suporta modificações simultâneas nas configurações do servidor IPsec sob o mesmo gateway VPN.

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

vpc:UpdateIpsecServer

update

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do servidor IPsec. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-shanghai
IpsecServerId	string	Sim	O ID do servidor IPsec.	iss-bp1bo3xuvcxo7ixll****
LocalSubnet	string	Não	O bloco CIDR local, que é o bloco CIDR no lado da VPC que precisa se comunicar com o bloco CIDR do cliente. Separe vários blocos CIDR com vírgulas (,). Exemplo: 192.168.1.0/24,192.168.2.0/24.	192.168.0.0/24,172.17.0.0/16
ClientIpPool	string	Não	O bloco CIDR do cliente, que é o bloco CIDR a partir do qual os endereços IP são atribuídos aos controladores de interface de rede virtual (NICs) do cliente. Nota O bloco CIDR do cliente não pode entrar em conflito com o bloco CIDR da VPC.	10.0.0.0/24
IpsecServerName	string	Não	O nome do servidor IPsec. O nome deve ter de 1 a 100 caracteres.	test
EffectImmediately	boolean	Não	Especifica se o túnel IPsec negociado atualmente deve ser excluído e a negociação reiniciada. Valores válidos: true: A negociação é iniciada imediatamente após a conclusão da configuração. false: A negociação é iniciada quando o tráfego de entrada é detectado.	false
IkeConfig	string	Não	A configuração dos parâmetros de negociação da Fase 1. Valores válidos: IkeVersion: A versão do protocolo Internet Key Exchange. Valores válidos: ikev1 ou ikev2. IkeMode: O modo de negociação da versão IKE. Valor padrão: main. IkeEncAlg: O algoritmo de criptografia usado na negociação da Fase 1. Valor padrão: aes. IkeAuthAlg: O algoritmo de autenticação usado na negociação da Fase 1. Valor padrão: sha1. IkePfs: O algoritmo de troca de chaves Diffie-Hellman usado na negociação da Fase 1. Valor padrão: group2. IkeLifetime: O tempo de vida da associação de segurança (SA) estabelecida na negociação da Fase 1. Unidade: segundos. Valores válidos: 0 a 86400. Valor padrão: 86400. LocalId: O identificador do servidor IPsec. Os formatos FQDN e endereço IP são suportados. RemoteId: O identificador do par. Os formatos FQDN e endereço IP são suportados.	{"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}
IpsecConfig	string	Não	As configurações dos parâmetros de negociação da Fase 2. Valores válidos: IpsecEncAlg: O algoritmo de criptografia usado na negociação da Fase 2. Valor padrão: aes. IpsecAuthAlg: O algoritmo de autenticação usado na negociação da Fase 2. Valor padrão: sha1. IpsecPfs: Encaminhar todos os pacotes de protocolo. O algoritmo de troca de chaves Diffie-Hellman usado na negociação da Fase 2. Valor padrão: group2. IpsecLifetime: A época da SA gerada na negociação da Fase 2. Unidade: segundos. Valores válidos: 0 a 86400. Valor padrão: 86400.	{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
PskEnabled	boolean	Não	Especifica se a autenticação por chave pré-compartilhada deve ser ativada. Valores válidos: true, que indica que a autenticação por chave pré-compartilhada está ativada.	true
Psk	string	Não	A chave pré-compartilhada. A chave pré-compartilhada é usada para autenticação de identidade entre o servidor IPsec e o cliente. A chave deve ter de 1 a 100 caracteres. Você pode chamar a operação ListIpsecServers para consultar a chave gerada pelo sistema. Nota A chave pré-compartilhada do servidor IPsec deve ser igual à chave de autenticação do cliente. Caso contrário, não será possível estabelecer uma conexão entre o servidor IPsec e o cliente.	Cfd123****
ClientToken	string	Não	O token do cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação de API como o ClientToken. O RequestId pode ser diferente para cada solicitação de API.	e4567-e89b-12d3-a456-42665544****
DryRun	string	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: Realiza um dry run sem atualizar a configuração do servidor IPsec. O sistema verifica se os parâmetros obrigatórios foram especificados, se o formato da solicitação é válido e se as restrições de negócios são atendidas. Se a verificação falhar, a mensagem de erro correspondente será retornada. Se a verificação for bem-sucedida, `DryRunOperation` será retornado. false (padrão): Realiza um dry run e envia a solicitação. Após a verificação ser bem-sucedida, a configuração do servidor IPsec é atualizada.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	B61C08E5-403A-46A2-96C1-F7B1216DB10C

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "B61C08E5-403A-46A2-96C1-F7B1216DB10C"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	OperationUnsupported.IpsecPfs	The specified IPsec Pfs is unsupported.	O PFS IPsec especificado não é suportado.
400	IllegalParam.AuthMethod	One authentication method (Psk or IDaaS) should be specified at least.	Pelo menos um método de autenticação (Psk ou IDaaS) deve ser especificado.
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.	O bloco CIDR local (%s) é inválido.
400	IllegalParam.ClientIpPool	The specified "ClientIpPool" (%s) is invalid.
400	MissingParam.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.	O ID da instância IDaaS é obrigatório quando a autenticação de dois fatores está ativada.
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.	O serviço VPN não tem permissão para operar em sua instância IDaaS.
400	OperationFailed.AddVpcRoute	It's failed to add VPC route after this operation.
400	ClientIpPool.NetmaskInvalid	The netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 29.	O comprimento da máscara de rede do pool de IPs do cliente deve ser maior ou igual a 16 e menor ou igual a 29.
400	VpnRouteEntry.Conflict	The specified client IP pool conflicts with VPN connection or SSL server.	O pool de IPs de cliente especificado entra em conflito com uma conexão VPN ou servidor SSL.
400	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.	O bloco CIDR do cliente especificado está indisponível.
400	InvalidClientIpPool.Conflict	The specified client IP pool conflicts with other resources in the same VPC.	O bloco CIDR do cliente entra em conflito com outros recursos na VPC.
400	SystemBusy	The system is busy. Please try again later.
403	Forbidden	User not authorized to operate on the specified resource.	O EIP não pertence ao chamador atual. Verifique se você tem permissão para chamar este EIP.
404	InvalidIpsecServerId.NotFound	The specified IPsec server ID (%s) does not exist.
404	InvalidIDaaSInstanceId.NotFound	The specified IDaaS instance ID does not exist.	O ID da instância IDaaS especificado não existe.
409	OperationConflict	The operation against this instance is too frequent, please try again later.	Ocorreu um conflito de solicitação. Tente novamente mais tarde.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.