DescribeRouterInterfaces - Virtual Private Cloud - Centre de documentation Alibaba Cloud

Consulte les interfaces de routeur dans une région spécifiée.

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

list

*RouterInterface.

acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'interface de routeur. Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.	cn-hangzhou
IncludeReservationData	boolean	Non	Indique si les données de renouvellement doivent être incluses. Valeurs valides : true false (valeur par défaut)	false
PageNumber	integer	Non	Le numéro de page. 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
Filter	array<object>	Non	Les informations de filtrage.
	object	Non	Les informations de filtrage.
Key	string	Non	La condition de filtrage. Vous pouvez spécifier jusqu'à 5 conditions de filtrage. Les conditions de filtrage suivantes sont prises en charge : RouterInterfaceId : l'identifiant de l'interface de routeur. RouterId : l'identifiant du routeur. RouterType : le type de routeur. Valeurs valides : VRouter et VBR. RouterInterfaceOwnerId : l'identifiant du compte auquel l'interface de routeur appartient. OppositeInterfaceId : l'identifiant de l'interface de routeur homologue. OppositeRouterType : le type d'interface de routeur homologue. Valeurs valides : VRouter et VBR. OppositeRouterId : l'identifiant de l'interface de routeur homologue. OppositeInterfaceOwnerId : l'identifiant du compte auquel l'interface de routeur homologue appartient. Status : l'état de l'interface de routeur. Name : le nom de l'interface de routeur. Remarque Les valeurs multiples de chaque condition de filtrage ont une relation OU, ce qui signifie qu'une correspondance avec l'une des valeurs satisfait la condition de filtrage. Les conditions de filtrage ont une relation ET, ce qui signifie que toutes les conditions de filtrage spécifiées doivent être remplies pour qu'un résultat soit retourné.	Filter.1.Status
Value	array	Non	La valeur de filtrage basée sur la clé spécifiée. Vous pouvez spécifier plusieurs valeurs de filtrage pour une clé. Les valeurs de filtrage ont une relation OU, ce qui signifie qu'une correspondance avec l'une des valeurs satisfait la condition de filtrage.	Filter.1.Active 1
	string	Non	La valeur de filtrage basée sur la clé spécifiée. Vous pouvez spécifier plusieurs valeurs de filtrage pour une clé. Les valeurs de filtrage ont une relation OU, ce qui signifie qu'une correspondance avec l'une des valeurs satisfait la condition de filtrage.	test
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Pour plus d'informations sur les groupes de ressources, consultez la section Qu'est-ce qu'un groupe de ressources ?.	rg-acfmxazb4ph6aiy****
Tags	array<object>	Non	Les balises de la ressource.
	object	Non	La balise.
Key	string	Non	La clé de balise de la ressource. Vous devez spécifier au moins 1 clé de balise et pouvez en spécifier jusqu'à 20. La clé de balise ne peut pas être une chaîne vide. Une clé de balise peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.	FinanceDept
Value	string	Non	La valeur de balise de la ressource. Vous pouvez spécifier jusqu'à 20 valeurs de balise. La valeur de balise peut être une chaîne vide. La valeur de balise peut comporter jusqu'à 128 caractères. Elle ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.	FinanceJoshua

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
PageNumber	integer	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Le nombre d'entrées par page dans une requête paginée. Valeur maximale : 50. Valeur par défaut : 10.	10
TotalCount	integer	Le nombre total d'entrées retournées.	1
RouterInterfaceSet	object
RouterInterfaceType	array<object>	Les détails des interfaces de routeur.
	array<object>	Les détails des interfaces de routeur.
ReservationActiveTime	string	L'heure d'activation du renouvellement. L'heure suit la norme ISO 8601 en UTC. Format : `YYYY-MM-DDThh:mmZ`.	2021-03-11T16:00:00Z
HealthCheckTargetIp	string	L'adresse IP cible du contrôle de santé.	116.62.XX.XX
Status	string	L'état de l'interface de routeur.	active
CreationTime	string	L'heure de création de la table de routage. L'heure suit la norme ISO 8601 en UTC. Format : `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
ReservationOrderType	string	Le type de commande de renouvellement.	RENEWCHANGE
OppositeInterfaceId	string	L'identifiant de l'interface de routeur homologue.	ri-bp1itx13bwe6f2wfh****
Spec	string	La spécification de l'interface de routeur.	Large
ChargeType	string	La méthode de facturation.	PayByTraffic
RouterInterfaceId	string	L'identifiant de l'interface de routeur.	ri-2zenfgfpyu3v93koa****
HcThreshold	integer	Le seuil du contrôle de santé.	2
OppositeRouterType	string	Le type du routeur auquel l'interface de routeur homologue appartient.	VRouter
VpcInstanceId	string	L'identifiant du VPC local dans la connexion d'appairage.	vpc-2ze3tq4uxhysg717x****
OppositeInterfaceOwnerId	string	L'identifiant du compte auquel l'interface de routeur homologue appartient.	271598332402530847
OppositeVpcInstanceId	string	L'identifiant du VPC homologue.	vpc-bp1qpo0kug3a20qqe****
ReservationInternetChargeType	string	Le type de facturation du renouvellement.	PayByBandwidth
CrossBorder	boolean	Indique si la connexion est une connexion transfrontalière.	false
Bandwidth	integer	La bande passante de l'interface de routeur. Unité : Mbit/s.	10
Description	string	La description de l'interface de routeur.	Description de l'interface de routeur
HcRate	integer	La fréquence du contrôle de santé.	1
ReservationBandwidth	string	La bande passante de renouvellement. Unité : Mbit/s.	10
Name	string	Le nom personnalisé.	test
OppositeRouterId	string	L'identifiant du routeur auquel l'interface de routeur homologue appartient.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceSpec	string	La spécification de l'interface de routeur homologue.	Large
RouterId	string	L'identifiant du routeur auquel l'entrée de routage appartient.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceBusinessStatus	string	L'état commercial de l'interface de routeur homologue.	Normal
ConnectedTime	string	L'heure à laquelle la connexion a été établie. L'heure suit la norme ISO 8601 en UTC. Format : `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
HealthCheckSourceIp	string	L'adresse IP source du contrôle de santé.	116.62.XX.XX
OppositeInterfaceStatus	string	L'état de l'interface de routeur homologue.	Normal
EndTime	string	L'heure de fin des données récupérées. L'heure suit la norme ISO 8601 en UTC. Format : `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
OppositeRegionId	string	L'identifiant de la région de l'interface de routeur homologue.	cn-shanghai
OppositeAccessPointId	string	L'identifiant du point d'accès homologue.	ap-cn-shanghaiSZ-****
BusinessStatus	string	L'état commercial de l'interface de routeur. Valeurs valides : Normal : Normal. FinancialLocked : verrouillé en raison d'un retard de paiement. SecurityLocked : verrouillé en raison d'un contrôle de risque de sécurité.	Normal
OppositeBandwidth	integer	La bande passante homologue. Unité : Mbit/s.	12
RouterType	string	Le type du routeur auquel la table de routage appartient. Valeurs valides : VRouter : un vRouter de VPC. VBR : un Virtual Border Router.	VRouter
Role	string	Le rôle dans la connexion d'appairage.	InitiatingSide
HasReservationData	string	Indique si des données de renouvellement existent.	false
AccessPointId	string	L'identifiant du point d'accès.	ap-cn-shanghaiSZ-****
Ipv6Status	string	Indique si la protection de sécurité IPv6 est activée. Valeurs valides : on : activée. off : désactivée. unsupport : non prise en charge.	on
FastLinkMode	boolean	Indique si l'interface de routeur sur le VBR a été créée en mode de liaison rapide. Le mode de liaison rapide établit automatiquement la connexion après la création des interfaces de routeur côté VBR et côté VPC. Valeurs valides : true false (valeur par défaut)	false
ResourceGroupId	string	L'identifiant du groupe de ressources. Pour plus d'informations sur les groupes de ressources, consultez la section Qu'est-ce qu'un groupe de ressources ?.	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	Les balises de la ressource.
	object	La balise.
Key	string	La clé de balise de la ressource.	FinanceDept
Value	string	La valeur de balise de la ressource.	FinanceJoshua

Exemples

JSON format

{
  "RequestId": "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RouterInterfaceSet": {
    "RouterInterfaceType": [
      {
        "ReservationActiveTime": "2021-03-11T16:00:00Z",
        "HealthCheckTargetIp": "116.62.XX.XX",
        "Status": "active",
        "CreationTime": "2021-06-08T12:20:55",
        "ReservationOrderType": "RENEWCHANGE",
        "OppositeInterfaceId": "ri-bp1itx13bwe6f2wfh****",
        "Spec": "Large",
        "ChargeType": "PayByTraffic",
        "RouterInterfaceId": "ri-2zenfgfpyu3v93koa****",
        "HcThreshold": 2,
        "OppositeRouterType": "VRouter",
        "VpcInstanceId": "vpc-2ze3tq4uxhysg717x****",
        "OppositeInterfaceOwnerId": "271598332402530847",
        "OppositeVpcInstanceId": "vpc-bp1qpo0kug3a20qqe****",
        "ReservationInternetChargeType": "PayByBandwidth",
        "CrossBorder": false,
        "Bandwidth": 10,
        "Description": "Description de l'interface de routeur",
        "HcRate": 1,
        "ReservationBandwidth": "10",
        "Name": "test",
        "OppositeRouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceSpec": "Large",
        "RouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceBusinessStatus": "Normal",
        "ConnectedTime": "2021-06-08T12:20:55",
        "HealthCheckSourceIp": "116.62.XX.XX",
        "OppositeInterfaceStatus": "Normal",
        "EndTime": "2021-06-08T12:20:55",
        "OppositeRegionId": "cn-shanghai",
        "OppositeAccessPointId": "ap-cn-shanghaiSZ-****",
        "BusinessStatus": "Normal",
        "OppositeBandwidth": 12,
        "RouterType": "VRouter",
        "Role": "InitiatingSide",
        "HasReservationData": "false",
        "AccessPointId": "ap-cn-shanghaiSZ-****",
        "Ipv6Status": "on",
        "FastLinkMode": false,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParam.NotNull	The parameter must not be null.
400	EndPoint.Empty	the rc endpoint is empty.
400	InvalidConnectionType.MalFormed	Connection type must be vpc2vpc or vbr2vpc.
400	InvalidProductForm.MalFormed	Product form must be routerinterface or expressconnect.
400	InvalidRole.Malformed	role must be InitiatingSide or AcceptingSide.
400	IllegalParam.AliUid	Specified value of aliuid invalid.
400	Parameter.Illegal	The parameter is illegal.	Le paramètre est invalide.
400	InvalidRegionId.NotFound	The specified RegionId does not exist.	Le paramètre est invalide.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Le paramètre est invalide.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key	La clé du filtre n'est pas prise en charge : Filter.X.key.

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

Notes de version

Consultez Notes de version pour la liste complète.