ModifyVpnGatewayAttribute - : Central de Documentação do Alibaba Cloud

Observações de uso

ModifyVpnGatewayAttribute é uma operação assíncrona. Após o envio da solicitação, o sistema retorna um ID de solicitação e executa a tarefa em segundo plano. Para consultar o status da tarefa, chame DescribeVpnGateway.
- Se o gateway VPN estiver no estado updating, ele está sendo modificado.
- Se o gateway VPN estiver no estado active, a modificação foi concluída com sucesso.
Não é permitido chamar ModifyVpnGatewayAttribute repetidamente para modificar um gateway VPN dentro do período especificado.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você execute esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ModifyVpnGatewayAttribute	A operação que você deseja executar. Defina o valor como ModifyVpnGatewayAttribute.
RegionId	String	Sim	ap-southeast-2	O ID da região onde o gateway VPN foi criado. Para obter a lista mais recente de regiões, chame a operação DescribeRegions.
ClientToken	String	Não	123e4567-e89b-12d3-a456-4266****	O token de cliente usado para garantir a idempotência da solicitação. Use o cliente para gerar o token, mas certifique-se de que ele seja exclusivo entre diferentes solicitações. O token de cliente pode conter apenas caracteres ASCII. Nota Caso este parâmetro não seja especificado, o sistema usará automaticamente o ID da solicitação como token de cliente. O ID da solicitação pode variar a cada requisição.
VpnGatewayId	String	Sim	vpn-bp1q8bgx4xnkm2ogj****	O ID do gateway VPN.
Name	String	Não	myvpn	O novo nome do gateway VPN. O nome deve ter entre 2 e 100 caracteres e não pode começar com `http://` ou `https://`. Deve iniciar com uma letra e pode conter letras, dígitos, sublinhados (_), hifens (-) e pontos (.). Outros caracteres não são suportados.
Description	String	Não	test	A nova descrição do gateway VPN. A descrição deve ter entre 1 e 100 caracteres e não pode começar com `http://` ou `https://`.
AutoPropagate	Boolean	Não	true	Define se as rotas BGP devem ser anunciadas automaticamente para a Virtual Private Cloud (VPC). Valores válidos: true false

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
VpcId	String	vpc-bp1ub1yt9cvakoel****	O ID da VPC à qual o gateway VPN pertence.
Status	String	active	O status do gateway VPN. init provisioning active updating deleting
InternetIp	String	116.62.XX.XX	Quando o gateway VPN suporta conexões IPsec-VPN em modo de túnel único, este endereço corresponde ao IP do gateway e serve para criar uma conexão IPsec-VPN ou SSL-VPN. Para gateways VPN que suportam conexões IPsec-VPN em modo de túnel duplo, este é o primeiro endereço IP utilizado na criação da conexão IPsec-VPN. Este endereço não permite a criação de conexões SSL-VPN. Nesse cenário de túnel duplo, o sistema atribui dois endereços IP ao gateway VPN para estabelecer dois túneis criptografados.
Spec	String	5M	A largura de banda máxima do gateway VPN. Unidade: Mbit/s.
CreateTime	Long	1492753580000	O momento em que o gateway VPN foi criado. Unidade: milissegundos. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.
AutoPropagate	Boolean	true	Indica se as rotas BGP são anunciadas automaticamente para a VPC. Valores válidos: true false
VpnGatewayId	String	vpn-bp1q8bgx4xnkm2ogj****	O ID do gateway VPN.
IntranetIp	String	172.27.30.24	O endereço IP do gateway VPN. Este parâmetro é retornado apenas quando o gateway VPN é privado e suporta exclusivamente o modo de túnel único.
EndTime	Long	1495382400000	A data de expiração do gateway VPN. Unidade: milissegundos. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.
VSwitchId	String	vsw-bp1y9ovl1cu9ou4tv****	O ID do vSwitch associado ao gateway VPN.
RequestId	String	54B48E3D-DF70-471B-AA93-08E683A1B457	O ID da solicitação.
Description	String	test	A descrição do gateway VPN.
EnableBgp	Boolean	true	Indica se o protocolo BGP está ativado no gateway VPN. Valores válidos: true false
BusinessStatus	String	Normal	O status de pagamento do gateway VPN. Valores válidos: Normal FinancialLocked
Name	String	test	O nome do gateway VPN.
DisasterRecoveryInternetIp	String	116.11.XX.XX	O segundo endereço IP atribuído pelo sistema para criar uma conexão IPsec-VPN. Este parâmetro é retornado apenas quando o gateway VPN suporta o modo de túnel duplo.
DisasterRecoveryVSwitchId	String	vsw-p0w95ql6tmr2ludkt****	O ID do segundo vSwitch associado ao gateway VPN. Este parâmetro é retornado apenas quando o gateway VPN suporta o modo de túnel duplo.
SslVpnInternetIp	String	116.33.XX.XX	O endereço IP da conexão SSL-VPN. Este parâmetro é retornado apenas quando o gateway VPN é público, suporta exclusivamente o modo de túnel único e possui o recurso SSL-VPN ativado.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ModifyVpnGatewayAttribute
&RegionId=ap-southeast-2
&ClientToken=123e4567-e89b-12d3-a456-4266****
&VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj****
&Name=myvpn
&Description=test
&AutoPropagate=true
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyVpnGatewayAttributeResponse>
    <VpcId>vpc-bp1ub1yt9cvakoel****</VpcId>
    <Status>active</Status>
    <InternetIp>116.62.XX.XX</InternetIp>
    <Spec>5M</Spec>
    <CreateTime>1492753580000</CreateTime>
    <AutoPropagate>true</AutoPropagate>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
    <EndTime>1495382400000</EndTime>
    <VSwitchId>vsw-bp1y9ovl1cu9ou4tv****</VSwitchId>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
    <Description>test</Description>
    <EnableBgp>true</EnableBgp>
    <BusinessStatus>Normal</BusinessStatus>
    <DisasterRecoveryVSwitchId>vsw-p0w95ql6tmr2ludkt****</DisasterRecoveryVSwitchId>
    <DisasterRecoveryInternetIp>116.11.XX.XX</DisasterRecoveryInternetIp>
    <SslVpnInternetIp>116.33.XX.XX</SslVpnInternetIp>
    <Name>test</Name>
</ModifyVpnGatewayAttributeResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "VpcId" : "vpc-bp1ub1yt9cvakoel****",
  "Status" : "active",
  "InternetIp" : "116.62.XX.XX",
  "Spec" : "5M",
  "CreateTime" : 1492753580000,
  "AutoPropagate" : true,
  "VpnGatewayId" : "vpn-bp1q8bgx4xnkm2ogj****",
  "EndTime" : 1495382400000,
  "VSwitchId" : "vsw-bp1y9ovl1cu9ou4tv****",
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "Description" : "test",
  "EnableBgp" : true,
  "BusinessStatus" : "Normal",
  "DisasterRecoveryVSwitchId" : "vsw-p0w95ql6tmr2ludkt****",
  "DisasterRecoveryInternetIp" : "116.11.XX.XX",
  "SslVpnInternetIp" : "116.33.XX.XX",
  "Name" : "test"
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	InvalidName	The name is not valid	A mensagem de erro retornada porque o formato do nome é inválido.
400	InvalidDescription	The description is not valid	A mensagem de erro retornada porque o formato da descrição é inválido.
400	OperationUnsupported.EnableBgp	Current version of the VPN does not support enable BGP.	A mensagem de erro retornada porque a versão atual do gateway VPN não suporta BGP.
400	OperationFailed.VpnConnectionExist	Auto propagate cannot be closed when VPN connections with BGP enabled exist.	A mensagem de erro retornada porque não é possível desativar o anúncio automático de rotas quando existe uma conexão VPN com BGP habilitado.
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	A mensagem de erro retornada porque o gateway VPN especificado não existe. Verifique se o gateway VPN informado é válido.
400	VpnGateway.Configuring	The specified service is configuring.	A mensagem de erro retornada porque a operação não é permitida enquanto o serviço especificado está sendo configurado. Tente novamente mais tarde.
400	OperationFailed.CenLevelNotSupport	When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.	A mensagem de erro retornada porque não é possível ativar o BGP em um gateway VPN quando a instância da Cloud Enterprise Network (CEN) à qual sua VPC está associada opera no modo FULL.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	A mensagem de erro retornada porque você não tem permissões para executar esta operação no recurso especificado. Obtenha as permissões necessárias e tente novamente.
403	Forbidden	User not authorized to operate on the specified resource.	A mensagem de erro retornada porque você não tem permissões para executar a operação no recurso especificado. Obtenha as permissões necessárias e tente novamente.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.