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

Cria uma rota de destino para um gateway VPN. Após a criação da rota de destino, o gateway VPN corresponde à rota de destino com base no endereço IP de destino do tráfego e encaminha o tráfego com base na rota de destino correspondente.

Descrição da operação

Antes de começar

Antes de criar uma rota de destino, certifique-se de ter criado uma conexão IPsec-VPN. Para mais informações, consulte CreateVpnConnection.
Antes de criar uma rota de destino, recomendamos que você compreenda as regras de correspondência das rotas de destino. Para mais informações, consulte Configurar rotas de destino.

Limites

0.0.0.0/0 não é suportado como o bloco CIDR de destino de uma rota de destino.
Para um gateway VPN de túnel único, um bloco CIDR que se sobrepõe a 100.64.0.0/10 (incluindo o próprio bloco CIDR, suas sub-redes e sua super-rede) não é suportado como o bloco CIDR de destino de uma rota de destino.
A operação CreateVpnRouteEntry é assíncrona. O sistema retorna as informações de configuração da rota de destino, mas a rota de destino ainda não foi criada. A tarefa de criação ainda está sendo executada em segundo plano. Você pode chamar a operação DescribeVpnGateway para consultar o status de criação da rota de destino:
- Se o gateway VPN estiver no estado updating, a rota de destino está sendo criada.
- Se o gateway VPN estiver no estado active, a rota de destino foi criada.
A operação CreateVpnRouteEntry não suporta a criação simultânea de rotas de destino no 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 o ID da região.	cn-hangzhou
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o valor, mas deve garantir que o valor seja exclusivo entre diferentes solicitações. O token de cliente 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 de cada solicitação de API é exclusivo.	d7d24a21-f4ba-4454-9173-b3828dae****
VpnGatewayId	string	Sim	O ID da instância do gateway VPN.	vpn-bp1a3kqjiiq9legfx****
RouteDest	string	Sim	O bloco CIDR de destino da rota de destino.	10.0.0.0/24
NextHop	string	Sim	O próximo salto da rota de destino.	vco-bp15oes1py4i66rmd****
Weight	integer	Sim	O peso da rota de destino. Em cenários em que você usa a mesma instância de gateway VPN para estabelecer conexões IPsec-VPN ativas/em espera, você pode especificar os links ativos/em espera configurando o peso da rota de destino. Uma rota de destino com peso 100 é o link ativo por padrão, e uma rota de destino com peso 0 é o link em espera por padrão. Você pode configurar verificações de integridade para a conexão IPsec-VPN para detectar automaticamente a conectividade dos links. Se o link ativo for desconectado, o sistema alternará automaticamente o tráfego para o link em espera para garantir a alta disponibilidade do link de acesso à nuvem. Para mais informações, consulte CreateVpnConnection. Valores válidos: 100: A conexão IPsec-VPN associada à rota de destino é o link ativo. 0: A conexão IPsec-VPN associada à rota de destino é o link em espera. Nota Ao especificar links ativos/em espera, as rotas de destino ativas e em espera devem ter o mesmo bloco CIDR de destino, próximos saltos diferentes e pesos diferentes. Para uma instância de gateway VPN que suporta conexões IPsec-VPN de padrão de túnel duplo, você não precisa configurar este parâmetro. Uma conexão IPsec-VPN de padrão de túnel duplo contém dois túneis que formam automaticamente links ativos/em espera. Você não precisa especificar links ativos/em espera configurando este parâmetro. Se você configurar este parâmetro, as configurações do parâmetro não terão efeito.	0
PublishVpc	boolean	Sim	Especifica se a rota de destino deve ser publicada na VPC. Valores válidos: true: Publica a rota de destino na VPC. O sistema publica a rota apenas na tabela de rotas do sistema da VPC, mas não na tabela de rotas personalizadas da VPC. Se você quiser que a tabela de rotas personalizadas da VPC inclua esta rota, deverá adicioná-la manualmente. Para mais informações, consulte CreateRouteEntry. false: Não publica a rota de destino na VPC. Você deve adicionar manualmente uma rota de destino cujo próximo salto aponte para o gateway VPN tanto na tabela de rotas do sistema quanto na tabela de rotas personalizadas da VPC. Caso contrário, a VPC não poderá acessar recursos no bloco CIDR por meio da conexão IPsec-VPN.	true
Description	string	Não	A descrição da rota de destino. A descrição deve ter de 1 a 100 caracteres e não pode começar com `http://` ou `https://`.	mytest
OverlayMode	string	Não	O protocolo de túnel. Defina o valor como Ipsec (protocolo de túnel IPsec).	Ipsec
DryRun	boolean	Não	Especifica se deve ser realizada apenas uma pré-verificação da solicitação. Valores válidos: true: Pré-verifica a solicitação sem criar a rota. O sistema verifica se os parâmetros obrigatórios foram especificados, se o formato da solicitação é válido e se os limites do serviço foram atendidos. Se a solicitação falhar na pré-verificação, o erro correspondente será retornado. Se a solicitação passar na pré-verificação, o código de erro `DryRunOperation` será retornado. false (padrão): Envia a solicitação. Se a solicitação passar na pré-verificação, o código de status HTTP 2xx será retornado e a operação será executada.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O resultado retornado.
NextHop	string	O próximo salto da rota de destino.	vco-bp15oes1py4i66rmd****
Weight	integer	O peso da rota de destino. Valores válidos: 100: A rota de destino tem prioridade mais alta. 0: A rota de destino tem prioridade mais baixa.	0
RouteDest	string	O bloco CIDR de destino da rota de destino.	10.0.0.0/24
RequestId	string	O ID da solicitação.	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
Description	string	A descrição da rota de destino.	mytest
State	string	O status de publicação da rota de destino. Valores válidos: published: A rota de destino é publicada na tabela de rotas da VPC. normal: A rota de destino não é publicada na tabela de rotas da VPC.	published
CreateTime	integer	O carimbo de data e hora em que a rota de destino foi criada. Unidade: milissegundos. O carimbo de data e hora está no formato UNIX, que representa a duração total desde 00:00:00 de 1º de janeiro de 1970 (UTC) até o momento em que a rota de destino foi criada.	1492747187000
OverlayMode	string	O protocolo de túnel. Defina o valor como Ipsec (protocolo de túnel IPsec).	Ipsec
VpnInstanceId	string	O ID da instância do gateway VPN.	vpn-bp1a3kqjiiq9legfx****

Exemplos

Resposta de sucesso

JSON formato

{
  "NextHop": "vco-bp15oes1py4i66rmd****",
  "Weight": 0,
  "RouteDest": "10.0.0.0/24",
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "Description": "mytest",
  "State": "published",
  "CreateTime": 1492747187000,
  "OverlayMode": "Ipsec",
  "VpnInstanceId": "vpn-bp1a3kqjiiq9legfx****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Resource.QuotaFull	The quota of resource is full
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	VpnRouteEntry.AlreadyExists	The specified route entry is already exist.	A rota já existe.
400	VpnRouteEntry.Conflict	The specified route entry has conflict.	Existe um conflito de entrada de rota.
400	VpnRouteEntry.ConflictSSL	The specified route entry has conflict with SSL client.	A entrada de rota entra em conflito com o cliente SSL.
400	VpnRouteEntry.BackupRoute	Validate backup route entry failed.	A validação da entrada de rotas ativas/em standby falhou. A configuração de roteamento é inválida.
400	VpnRouteEntry.InvalidWeight	Invalid route entry weight value.	O valor do peso da rota é inválido.
400	InvalidNextHop.NotFound	The specified NextHop does not exist.	O próximo salto especificado não existe.
400	IllegalParam.RouteDest	The specified RouteDest is invalid	O endereço de destino é inválido.
400	OperationFailed.RouteConflict	Operation failed because there is already a route in VPC route table to another VPN on the same network block.	Os blocos CIDR na lista de prefixos especificada entram em conflito com entradas de rota existentes na conexão IPsec-VPN. Resolva os conflitos e tente novamente.
400	OperationFailed.InvalidCidrBlock	Operation failed because the specified network block is invalid.	O bloco CIDR é inválido.
400	QuotaExceeded.VpnRouteEntry	The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit.	O número de entradas de rota apontando para o gateway VPN na tabela de rotas da VPC atingiu o limite de cota.
400	TaskConflict	The operation is too frequent, please wait a moment and try again.	As operações de EIP são muito frequentes.
400	VpnTask.CONFLICT	Vpn task has conflict.	Ocorreu um conflito de operação de VPN. Tente novamente mais tarde.
400	IncorrectVpcStatus	Current VPC status does not support this operation.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	InvalidCidrBlock.Malformed	Specified CIDR block is not valid.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	A verificação DryRun foi aprovada.
400	CreatePbrRoutesQuotaFull.QuotaFull	The number of policy routes exceeds the quota limit.	O número de rotas baseadas em políticas excede o limite de cota.
400	CreateDbrRoutesQuotaFull.QuotaFull	The number of created destination routes exceeds the quota limit.	O número de rotas de destino excede o limite de cota.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
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.