DescribeVpnRouteEntries - VPN Gateway - Centre de documentation Alibaba Cloud

Consulte les informations sur les routes de destination et les routes BGP d'une instance de passerelle VPN en appelant l'opération DescribeVpnRouteEntries.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

vpc:DescribeVpnRouteEntries

get

*VpnGateway

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'instance de passerelle VPN. Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.	cn-hangzhou
VpnGatewayId	string	Oui	L'identifiant de l'instance de la passerelle VPN.	vpn-bp1cmw7jh1nfe43m9****
PageNumber	integer	Non	Le numéro de page de la liste. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page dans une requête paginée. Valeur maximale : 50. Valeur par défaut : 10.	10
RouteEntryType	string	Non	Le type de destination de l'entrée de routage. Valeurs valides : custom (par défaut) : interroge les routes de destination de l'instance de passerelle VPN. bgp : interroge les routes BGP de l'instance de passerelle VPN.	custom

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
PageSize	integer	Le nombre d'entrées par page dans une requête paginée.	10
RequestId	string	L'identifiant de la requête.	BF3995A6-FA4F-4C74-B90F-89ECF4BFF4D5
PageNumber	integer	Le numéro de page de la liste.	1
TotalCount	integer	Le nombre total d'entrées dans la liste.	1
VpnRouteEntries	object
VpnRouteEntry	array<object>	La liste des entrées de route.
	object	Les détails de l'entrée de route.
RouteEntryType	string	The type of the route entry. custom: a destination route of the VPN gateway instance. bgp: a BGP route of the VPN gateway instance.	custom
NextHop	string	The next hop of the route entry.	vco-bp1tui07ob10fmuro****
Weight	integer	The weight of the destination route. For VPN gateway instances that support dual-tunnel mode IPsec-VPN connections, the weight of the destination route defaults to 100 and has no practical significance. For VPN gateway instances that support single-tunnel mode IPsec-VPN connections, the weight represents the priority of the destination route: 100: high priority. When multiple destination routes with the same destination CIDR block exist, the IPsec-VPN connection associated with this destination route serves as the active link. 0: low priority. When multiple destination routes with the same destination CIDR block exist, the IPsec-VPN connection associated with this destination route serves as the standby link.	100
RouteDest	string	The destination CIDR block of the route entry.	10.0.0.0/24
AsPath	string	The AS path of the route entry.	65501,65001,60011
State	string	The status of the route entry. Valid values: published: published. normal: not published.	normal
CreateTime	integer	The timestamp when the route entry was created. The timestamp is in the UNIX format and represents the total number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1563874074000
Community	string	The community attribute value of the route entry.	65001:1000,65501:2000
Source	string	The source of the BGP route. CLOUD: the route is propagated from an Alibaba Cloud service associated with the VPN gateway. VPN_BGP: the route is learned through the BGP routing protocol of the VPN gateway, such as routes learned from an on-premises data center through BGP.	CLOUD
VpnInstanceId	string	The instance ID of the VPN gateway.	vpn-bp1cmw7jh1nfe43m9****
NextHopTunnelId	string	The tunnel ID associated with the next hop of the route entry. Remarque This parameter is returned only for VPN gateway instances that support dual-tunnel mode IPsec-VPN connections.	tun-36cfgpwjn58axj****
VpnRouteCounts	object
VpnRouteCount	array<object>	Les statistiques de route de l'instance de passerelle VPN en mode double tunnel. Remarque Ces informations ne sont renvoyées que pour les instances de passerelle VPN qui prennent en charge les connexions IPsec-VPN à double tunnel.
	object	Les statistiques des routes.
RouteEntryType	string	The type of the route entry. custom: destination route entry. bgp: BGP route entry.	bgp
RouteCount	integer	The number of route entries.	3
Source	string	The source of the BGP route. CLOUD: the route is propagated from an Alibaba Cloud service associated with the VPN gateway. VPN_BGP: the route is learned through the BGP routing protocol of the VPN gateway, such as routes learned from an on-premises data center through BGP.	VPN_BGP

Exemples

JSON format

{
  "PageSize": 10,
  "RequestId": "BF3995A6-FA4F-4C74-B90F-89ECF4BFF4D5",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnRouteEntries": {
    "VpnRouteEntry": [
      {
        "RouteEntryType": "custom",
        "NextHop": "vco-bp1tui07ob10fmuro****",
        "Weight": 100,
        "RouteDest": "10.0.0.0/24",
        "AsPath": "65501,65001,60011",
        "State": "normal",
        "CreateTime": 1563874074000,
        "Community": "65001:1000,65501:2000",
        "Source": "CLOUD",
        "VpnInstanceId": "vpn-bp1cmw7jh1nfe43m9****",
        "NextHopTunnelId": "tun-36cfgpwjn58axj****"
      }
    ]
  },
  "VpnRouteCounts": {
    "VpnRouteCount": [
      {
        "RouteEntryType": "bgp",
        "RouteCount": 3,
        "Source": "VPN_BGP"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	IllegalParam.RouteEntryType	The specified "RouteEntryType" is invalid.
400	InvalidVpnInstanceId.NotFound	The specified VPN was not found.
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.
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.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.