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

Consulta as rotas de uma conexão IPsec-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 da conexão IPsec-VPN. Você pode chamar a operação DescribeRegions para consultar a lista mais recente de regiões.	cn-hangzhou
VpnConnectionId	string	Sim	O ID da conexão IPsec-VPN.	vco-p0w2jpkhi2eeop6q6****
RouteEntryType	string	Não	O tipo de rota. Valores válidos: custom (padrão): uma rota baseada em destino bgp: uma rota BGP	custom
PageNumber	integer	Não	O número da página a ser retornada. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valor padrão: 10. Valores válidos: 1 a 50.	10
ClientToken	string	Não	O token do 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 único entre todas as solicitações. O ClientToken pode conter apenas caracteres ASCII. Nota Se você não definir este parâmetro, o sistema usará o RequestId como ClientToken. O valor do RequestId para cada solicitação de API pode ser diferente.	123e4567-e89b-12d3-a456-4266****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
TotalCount	integer	O número de entradas retornadas.	1
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas retornadas por página.	10
VcoRouteEntries	array<object>	A lista de entradas de rota.
	object	As informações sobre as rotas.
VpnConnectionId	string	O ID da conexão IPsec-VPN.	vco-p0w2jpkhi2eeop6q6****
RouteDest	string	O bloco CIDR de destino da rota.	192.168.10.0/24
NextHop	string	O próximo salto da rota.	vco-p0w2jpkhi2eeop6q6****
Weight	integer	O peso da rota baseada em destino. Nota Este parâmetro não tem efeito.	100
State	string	O status da rota. published: indica que a rota atual é anunciada para o roteador de trânsito. Active: indica que a rota BGP atual está disponível.	published
RouteEntryType	string	O tipo de rota. Valores válidos: custom: uma rota baseada em destino bgp: uma rota BGP	custom
CreateTime	integer	O carimbo de data e hora em que a rota foi criada. Este valor é um carimbo de data e hora UNIX que representa o número de milissegundos decorridos desde a época de 1º de janeiro de 1970, 00:00:00 UTC.	1658217008000
AsPath	string	A lista de números de sistema autônomo (AS) pelos quais a rota BGP passa.	[12000]
Community	string	O valor de comunidade transportado pela rota BGP.	65535:65510
Source	string	A origem da rota BGP. Valores válidos: CLOUD: indica que a rota BGP atual é aprendida pela conexão IPsec-VPN a partir do roteador de trânsito. VPN_BGP: indica que a rota BGP atual é aprendida pela conexão IPsec-VPN a partir do data center.	CLOUD
NextHopTunnelIdList	array	A lista de próximos saltos. Nota Este parâmetro é retornado apenas por conexões IPsec de túnel duplo. Este parâmetro é retornado apenas quando o status do túnel é Phase 2 Negotiation Successful.
	string	O ID do túnel.	tun-0jothw962cp3bvhbw****
RequestId	string	O ID da solicitação.	E18980E8-C8C2-31BD-8156-AE2BBDEC87E1
VpnRouteCounts	array<object>	As informações sobre as entradas de rota da conexão IPsec de túnel duplo. Nota Este parâmetro é retornado apenas para conexões IPsec no modo de túnel duplo.
	object	As informações sobre as entradas de rota.
RouteEntryType	string	O tipo de rota. Valores válidos: custom: rota baseada em destino. bgp: rota BGP.	bgp
RouteCount	integer	O número de entradas de rota.	3
Source	string	A origem da rota BGP. Valores válidos: CLOUD: A rota BGP atual é aprendida pela conexão IPsec a partir do roteador de trânsito. VPN_BGP: A rota BGP atual é aprendida pela conexão IPsec a partir do data center.	VPN_BGP

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "VcoRouteEntries": [
    {
      "VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
      "RouteDest": "192.168.10.0/24",
      "NextHop": "vco-p0w2jpkhi2eeop6q6****",
      "Weight": 100,
      "State": "published",
      "RouteEntryType": "custom",
      "CreateTime": 1658217008000,
      "AsPath": "[12000]",
      "Community": "65535:65510",
      "Source": "CLOUD",
      "NextHopTunnelIdList": [
        "tun-0jothw962cp3bvhbw****"
      ]
    }
  ],
  "RequestId": "E18980E8-C8C2-31BD-8156-AE2BBDEC87E1",
  "VpnRouteCounts": [
    {
      "RouteEntryType": "bgp",
      "RouteCount": 3,
      "Source": "VPN_BGP"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalParam.RouteEntryType	The specified RouteEntryType is invalid.	The error message returned because the specified route type is invalid.
400	Vco.StatusNotSupport	The current VPN connection state does not support this operation.	The operation cannot be performed when the VPN connection is in the current state.
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.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	The specified vpn connection 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.