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

Cria uma rota baseada em política de VPN.

Descrição da operação

Antes de começar

Antes de criar uma rota baseada em política, certifique-se de ter criado uma conexão IPsec-VPN. Para mais informações, consulte CreateVpnConnection.
Antes de criar uma rota baseada em política, familiarize-se com os limites e as regras de correspondência das rotas baseadas em política. Para mais informações, consulte Usar rotas baseadas em política.

Limites

Para gateways VPN de túnel único:
- 0.0.0.0/0 não é suportado como o bloco CIDR de destino de uma rota baseada em política.
- Blocos CIDR que se sobrepõem a 100.64.0.0/10 (incluindo o próprio 100.64.0.0/10, suas sub-redes e seus blocos CIDR pai) não são suportados como o bloco CIDR de destino de uma rota baseada em política.
A operação CreateVpnPbrRouteEntry é assíncrona. O sistema retorna as informações da rota baseada em política antes que a rota seja criada. A tarefa de criação ainda está em execução em segundo plano. Você pode chamar a operação DescribeVpnGateway para consultar o status da instância do gateway VPN e verificar o status de criação da rota baseada em política:
- Se a instância do gateway VPN estiver no estado updating, a rota baseada em política está sendo criada.
- Se a instância do gateway VPN estiver no estado active, a rota baseada em política foi criada.
A operação CreateVpnPbrRouteEntry não suporta a criação simultânea de rotas baseadas em política na mesma instância de 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:CreateVpnPbrRouteEntry

create

*VpnGateway.

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

Nenhuma

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 de 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 ele 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-b3****
VpnGatewayId	string	Sim	O ID do gateway VPN.	vpn-bp1a3kqjiiq9legfx****
RouteSource	string	Sim	O bloco CIDR de origem da rota baseada em política.	192.168.1.0/24
RouteDest	string	Sim	O bloco CIDR de destino da rota baseada em política.	10.0.0.0/24
NextHop	string	Sim	O próximo salto da rota baseada em política.	vco-bp15oes1py4i66rmd****
Weight	integer	Sim	O peso da rota baseada em política. Ao usar 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 baseada em política. Uma rota baseada em política com peso 100 é o link ativo por padrão, e uma rota baseada em política com peso 0 é o link em espera por padrão. Você pode configurar verificações de integridade para as conexões IPsec-VPN para detectar automaticamente a conectividade dos links. Se o link ativo falhar, 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 baseada em política é o link ativo. 0: A conexão IPsec-VPN associada à rota baseada em política é o link em espera. Nota Ao especificar os links ativos/em espera, os blocos CIDR de origem e destino das rotas baseadas em política ativas/em espera devem ser iguais. Para instâncias de gateway VPN que suportam conexões IPsec-VPN de túnel duplo, não é necessário configurar este parâmetro. Uma conexão IPsec-VPN de túnel duplo contém dois túneis que formam automaticamente links ativos/em espera. Não é necessário especificar os links ativos/em espera configurando este parâmetro. Se você configurar este parâmetro, as configurações não terão efeito.	0
PublishVpc	boolean	Sim	Especifica se a rota baseada em política deve ser publicada na VPC. Valores válidos: true: Publica a rota baseada em política na VPC. O sistema publica a rota apenas na tabela de rotas do sistema da VPC, mas não nas tabelas de rotas personalizadas. Se você quiser que as tabelas de rotas personalizadas da VPC incluam esta rota, deverá adicioná-la manualmente. Para mais informações, consulte CreateRouteEntry. false: Não publica a rota baseada em política nas tabelas de rotas da VPC. Você deve adicionar manualmente uma rota baseada em política cujo próximo salto aponte para o gateway VPN tanto na tabela de rotas do sistema quanto nas tabelas 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 baseada em política. A descrição deve ter de 1 a 100 caracteres.	desctest
OverlayMode	string	Não	O protocolo de túnel. Defina o valor como Ipsec (protocolo de túnel IPsec).	Ipsec
Priority	integer	Não	A prioridade da política da rota baseada em política. Valores válidos: 1 a 100. Valor padrão: 10. Um valor menor indica uma prioridade de política maior.	10
DryRun	boolean	Não	Especifica se deve ser realizada apenas uma pré-verificação da solicitação. Valores válidos: true: Realiza a pré-verificação da solicitação sem criar a rota. O sistema verifica se os parâmetros obrigatórios foram especificados, o formato da solicitação e os limites do serviço. 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	A resposta.
NextHop	string	O próximo salto da rota baseada em política.	vco-bp15oes1py4i66rmd****
Weight	integer	O peso da rota baseada em política. 100: A conexão IPsec-VPN associada à rota baseada em política é o link ativo. 0: A conexão IPsec-VPN associada à rota baseada em política é o link em espera.	0
RouteDest	string	O bloco CIDR de destino da rota baseada em política.	10.0.0.0/24
RequestId	string	O ID da solicitação.	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
Description	string	A descrição da rota baseada em política.	desctest
State	string	O status de publicação da rota baseada em política. published: A rota baseada em política está publicada nas tabelas de rotas da VPC. normal: A rota baseada em política não está publicada nas tabelas de rotas da VPC.	normal
CreateTime	integer	O carimbo de data/hora de quando a rota baseada em política foi criada. Unidade: milissegundos. O carimbo de data/hora segue o formato de hora UNIX. É o número total de milissegundos decorridos desde 00:00:00 de quinta-feira, 1º de janeiro de 1970 (UTC).	1492747187000
OverlayMode	string	O protocolo de túnel. Defina o valor como Ipsec (protocolo de túnel IPsec).	Ipsec
RouteSource	string	O bloco CIDR de origem da rota baseada em política.	192.168.1.0/24
VpnInstanceId	string	O ID do gateway VPN.	vpn-bp1cmw7jh1nfe43m9****
Priority	integer	A prioridade da política da rota baseada em política.	10

Exemplos

Resposta de sucesso

JSON formato

{
  "NextHop": "vco-bp15oes1py4i66rmd****",
  "Weight": 0,
  "RouteDest": "10.0.0.0/24",
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "Description": "desctest",
  "State": "normal",
  "CreateTime": 1492747187000,
  "OverlayMode": "Ipsec",
  "RouteSource": "192.168.1.0/24",
  "VpnInstanceId": "vpn-bp1cmw7jh1nfe43m9****",
  "Priority": 10
}

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.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	VpnPbrRouteEntryPriority.NotSupport	Current version of the VPN does not support setting custom pbr route entry priority.	A versão atual do gateway VPN não suporta o recurso de prioridade de rota de política.
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	VpnGateway.Configuring	The specified service is configuring.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	VpnRouteEntry.SrcDestWeightConflict	The VPN gateway does not support Policy-based routing with the same source CIDR, destination CIDR and weight.	O gateway VPN não oferece suporte a rotas baseadas em política que tenham o mesmo bloco CIDR de origem, bloco CIDR de destino e peso ao mesmo tempo.
400	VpnRouteEntry.SamePriorityPbrRoutePrefixOverlap	The source CIDR and destination CIDR of Policy-based routes with the same priority cannot overlap.	O gateway VPN não oferece suporte a várias rotas baseadas em política com a mesma prioridade cujos blocos CIDR de origem e destino se sobreponham ao mesmo tempo.
400	VpnRouteEntry.SrcDestConflict	The VPN gateway does not support Policy-based routing with the same source CIDR and destination CIDR.	Um gateway VPN de túnel duplo não oferece suporte a rotas baseadas em política que tenham o mesmo bloco CIDR de origem e bloco CIDR de destino ao mesmo tempo.
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	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	VpnPbrRouteEntry.NotSupport	Current version of the VPN does not support pbr route entry.	A instância VPN atual não suporta roteamento baseado em políticas.
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.