Todos os produtos
Search
Central de documentação

VPN Gateway:ModifyVpnGatewayAttribute

Última atualização: Oct 10, 2026

Modifica o nome, a descrição ou o recurso de propagação automática de rotas de um gateway VPN.

Descrição da operação

  • A operação ModifyVpnGatewayAttribute é assíncrona. O sistema retorna as informações do gateway VPN antes que a configuração seja modificada. A tarefa de modificação ainda está em execução em segundo plano. Você pode chamar a operação DescribeVpnGateway para consultar o status da modificação da configuração do gateway VPN:
    • Se o gateway VPN estiver no estado updating, a configuração está sendo modificada.

    • Se o gateway VPN estiver no estado active, a configuração foi modificada.

  • A operação ModifyVpnGatewayAttribute não suporta modificações simultâneas na configuração do 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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

RegionId

string

Sim

O ID da região do gateway VPN. Você pode chamar a operação DescribeRegions para consultar os IDs das regiões.

cn-hangzhou

ClientToken

string

Não

O token de cliente usado para garantir a idempotência da solicitação.

Você pode gerar o valor do parâmetro em seu cliente para garantir que o valor seja exclusivo entre diferentes solicitações. O token de cliente suporta 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 token de cliente. O RequestId de cada solicitação de API é diferente.

123e4567-e89b-12d3-a456-4266****

VpnGatewayId

string

Sim

O ID do gateway VPN.

vpn-bp1q8bgx4xnkm2ogj****

Name

string

Não

O novo nome do gateway VPN.

O nome deve ter de 2 a 100 caracteres. Não pode começar com http:// ou https://. Deve começar com uma letra e pode conter letras, dígitos, sublinhados (_), hifens (-) e pontos (.). Outros caracteres especiais não são suportados.

myvpn

Description

string

Não

A nova descrição do gateway VPN.

A descrição deve ter de 1 a 100 caracteres.

test

AutoPropagate

boolean

Não

Especifica se o recurso de propagação automática de rotas deve ser ativado para o gateway VPN. Valores válidos:

  • true: ativa o recurso.

    Após a ativação da propagação automática de rotas, a instância do gateway VPN aprende automaticamente as rotas do sistema na tabela de rotas do sistema da VPC e propaga automaticamente as rotas do data center local para a tabela de rotas do sistema da VPC.

  • false: desativa o recurso.

    Antes de desativar a propagação automática de rotas, certifique-se de que o recurso de rota dinâmica BGP esteja desativado para todas as conexões IPsec-VPN no gateway VPN.

true

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

A resposta.

VpcId

string

O ID da VPC à qual o gateway VPN pertence.

vpc-bp1ub1yt9cvakoel****

Status

string

O status do gateway VPN. Valores válidos:

  • init: inicializando

  • provisioning: preparando

  • active: ativo

  • updating: atualizando

  • deleting: excluindo

active

InternetIp

string

  • Se o gateway VPN suportar conexões IPsec-VPN de túnel único, este parâmetro indica o endereço IP do gateway VPN, que pode ser usado para criar uma conexão IPsec-VPN ou uma conexão SSL-VPN.

  • Se o gateway VPN suportar conexões IPsec-VPN de túnel duplo, este parâmetro indica o primeiro endereço IP usado para criar uma conexão IPsec-VPN. Ele não pode ser usado para criar uma conexão SSL-VPN.

    Se o gateway VPN suportar conexões IPsec-VPN de túnel duplo, o sistema atribuirá dois endereços IPsec ao gateway VPN para a criação de conexões IPsec-VPN de túnel duplo.

116.62.XX.XX

Spec

string

A especificação de largura de banda do gateway VPN. Unidade: Mbit/s.

5M

CreateTime

integer

O carimbo de data e hora de quando o gateway VPN foi criado. Unidade: milissegundos.

O carimbo de data e hora segue o formato de hora UNIX. Indica o número total de milissegundos decorridos desde a época de 1 de janeiro de 1970, 00:00:00 UTC.

1492753580000

AutoPropagate

boolean

Especifica se as rotas BGP são propagadas automaticamente para a VPC. Valores válidos:

  • true: propagadas automaticamente

  • false: não propagadas automaticamente

true

VpnGatewayId

string

O ID do gateway VPN.

vpn-bp1q8bgx4xnkm2ogj****

IntranetIp

string

O endereço IP privado do vSwitch que é ocupado quando o sistema implanta o gateway VPN.

Este parâmetro é retornado apenas para gateways VPN que suportam apenas conexões IPsec-VPN de túnel único e têm o recurso IPsec-VPN ativado.

172.16.10.46

EndTime

integer

O carimbo de data e hora UNIX de quando a instância do gateway VPN expira. Unidade: milissegundos.

O carimbo de data e hora UNIX segue o formato de hora UNIX. Indica o número total de milissegundos decorridos desde a época de 1 de janeiro de 1970, 00:00:00 UTC até a expiração da instância do gateway VPN.

1495382400000

VSwitchId

string

O ID do vSwitch associado ao gateway VPN.

vsw-bp1y9ovl1cu9ou4tv****

RequestId

string

O ID da solicitação.

54B48E3D-DF70-471B-AA93-08E683A1B457

Description

string

A descrição do gateway VPN.

test

EnableBgp

boolean

Especifica se o recurso BGP está ativado para o gateway VPN. Valores válidos:

  • true: ativado

  • false: desativado

true

BusinessStatus

string

O status de faturamento da instância do gateway VPN. Valores válidos:

  • Normal: normal

  • FinancialLocked: bloqueado devido a pagamentos em atraso

Normal

Name

string

O nome do gateway VPN.

test

DisasterRecoveryInternetIp

string

O segundo endereço IP atribuído pelo sistema ao gateway VPN para a criação de uma conexão IPsec-VPN.

Este parâmetro é retornado apenas para gateways VPN que suportam conexões IPsec-VPN de túnel duplo.

116.11.XX.XX

DisasterRecoveryVSwitchId

string

O ID do segundo vSwitch associado ao gateway VPN.

Este parâmetro é retornado apenas para gateways VPN que suportam conexões IPsec-VPN de túnel duplo.

vsw-p0w95ql6tmr2ludkt****

SslVpnInternetIp

string

O endereço IP da conexão SSL-VPN.

Este parâmetro é retornado apenas após a ativação do recurso SSL-VPN para uma instância de gateway VPN do tipo de rede pública que suporta conexões IPsec-VPN de túnel duplo.

116.33.XX.XX

ResourceGroupId

string

O ID do grupo de recursos ao qual o gateway VPN pertence.

Você pode chamar a operação ListResourceGroups para consultar as informações do grupo de recursos.

rg-acfmzs372yg****

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 InvalidName The name is not valid
400 InvalidDescription The description is not valid
400 OperationUnsupported.EnableBgp Current version of the VPN does not support enable BGP. 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 propagação automática de rotas não pode ser desativada quando existe uma conexão VPN com BGP ativado.
400 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist. O gateway VPN especificado não existe. Verifique se o gateway VPN está correto.
400 VpnGateway.Configuring The specified service is configuring.
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. O BGP não pode ser ativado para um gateway VPN quando a VPC à qual o gateway VPN pertence está anexada a uma instância do Cloud Enterprise Network com a sincronização de rotas ativada.
400 OperationFailed.VpcRoutePropagationDisable The VPC system routing table does not enable the acceptance of propagated routes. A tabela de rotas do sistema da VPC não tem a aceitação de propagação de rotas ativada.
400 OperationFailed.VpcRoutePublishEnabledInTR A VPC supports at most one dynamic route learning source. In the forwarding router, disable route synchronization for the VPC. Uma VPC suporta apenas uma origem de aprendizado de rotas dinâmicas. Desative a sincronização de rotas para a VPC no transit router.
400 OperationFailed.VpcRoutePublishEnabledInECR VPC supports only one dynamic route learning source at most. Please remove the VPC from ECR. Uma VPC suporta apenas uma origem de aprendizado de rotas dinâmicas. Remova a VPC do Express Connect Router (ECR).
400 OperationFailed.BondingVpnNotSupportBGP The architecture does not support BGP capabilities (single tunnel bonding architecture VPN gateway). A arquitetura não suporta recursos de BGP (gateway de VPN com arquitetura de bonding de túnel único).
400 OperationFailed.StaleBGPRoutes BGP routes are still there and automatic route propagation cannot be disabled. Existem rotas BGP residuais. A propagação automática de rotas não pode ser desativada.
403 Forbidden.SubUser User not authorized to operate on the specified resource as your account is created by another user. Você não tem permissão para realizar operações neste recurso. Solicite a permissão necessária e tente novamente.
403 Forbidden User not authorized to operate on the specified resource. Você não tem as permissões para realizar operações no recurso especificado. Solicite as permissões necessárias e tente novamente.
404 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.