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

Consulta as rotas baseadas em política configuradas para uma instância de gateway VPN chamando a operação DescribeVpnPbrRouteEntries.

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:DescribeVpnPbrRouteEntries

get

*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 da instância do gateway VPN. Você pode chamar a operação DescribeRegions para consultar o ID da região.	eu-central-1
VpnGatewayId	string	Sim	O ID da instância do gateway VPN.	vpn-bp1a3kqjiiq9legfx****
PageNumber	integer	Não	O número da página da lista. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Valor máximo: 50. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
PageSize	integer	O número de entradas por página em uma consulta paginada.	10
RequestId	string	O ID da solicitação.	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
PageNumber	integer	O número da página da lista.	1
TotalCount	integer	O número total de entradas na lista.	1
VpnPbrRouteEntries	object
VpnPbrRouteEntry	array<object>	A lista de rotas baseadas em política.
	object	As informações sobre a rota baseada em política.
NextHop	string	O próximo salto da rota baseada em política.	vco-bp15oes1py4i66rmd****
Weight	integer	O peso da rota baseada em política. Para instâncias de gateway VPN que suportam conexões IPsec-VPN de túnel único, o valor do peso representa a prioridade da rota baseada em política: 100: alta prioridade. Se existirem várias rotas baseadas em política com os mesmos blocos CIDR de origem e destino, a conexão IPsec-VPN associada a esta rota baseada em política serve como o link ativo. 0: baixa prioridade. Se existirem várias rotas baseadas em política com os mesmos blocos CIDR de origem e destino, a conexão IPsec-VPN associada a esta rota baseada em política serve como o link de standby. Nota Para instâncias de gateway VPN que suportam conexões IPsec-VPN de túnel duplo, este parâmetro não entra em vigor.	100
RouteDest	string	O bloco CIDR de destino da rota baseada em política.	10.0.0.0/24
State	string	O status de publicação da rota baseada em política. published: A rota baseada em política está publicada na tabela de rotas da VPC. normal: A rota baseada em política não está publicada na tabela de rotas da VPC.	published
CreateTime	integer	O timestamp de quando a rota baseada em política foi criada. Unidade: milissegundos. O timestamp está no formato UNIX e representa o número total de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1492747187000
VpnInstanceId	string	O ID da instância do gateway VPN.	vpn-bp1a3kqjiiq9legfx****
RouteSource	string	O bloco CIDR de origem da rota baseada em política.	192.168.0.0/24
Priority	integer	A prioridade da política da rota baseada em política. Um valor menor indica uma prioridade maior.	10
NextHopTunnelId	string	O ID do túnel associado ao próximo salto da rota baseada em política. Este parâmetro é retornado apenas para instâncias de gateway VPN que suportam conexões IPsec-VPN de túnel duplo.	tun-opsqc4d97wni2****

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnPbrRouteEntries": {
    "VpnPbrRouteEntry": [
      {
        "NextHop": "vco-bp15oes1py4i66rmd****",
        "Weight": 100,
        "RouteDest": "10.0.0.0/24",
        "State": "published",
        "CreateTime": 1492747187000,
        "VpnInstanceId": "vpn-bp1a3kqjiiq9legfx****",
        "RouteSource": "192.168.0.0/24",
        "Priority": 10,
        "NextHopTunnelId": "tun-opsqc4d97wni2****"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidVpnInstanceId.NotFound	The specified VPN was not found.	A instância VPN especificada não foi encontrada.
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.
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.	O EIP não pertence ao chamador atual. Verifique se você tem permissão para chamar este EIP.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.