ListTransitRouters - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Spécifiez les paramètres RegionId et TransitRouterId selon vos besoins.

Si vous ne spécifiez ni RegionId ni TransitRouterId, le système répertorie tous les routeurs de transit connectés à l'instance CEN spécifiée.
Si vous spécifiez uniquement RegionId, le système répertorie les routeurs de transit déployés dans la région indiquée.
Si vous spécifiez uniquement TransitRouterId, le système répertorie le routeur de transit indiqué.
Si vous spécifiez à la fois RegionId et TransitRouterId, le système répertorie le routeur de transit indiqué dans la région spécifiée.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListTransitRouters	L'opération que vous souhaitez effectuer. Définissez la valeur sur ListTransitRouters.
PageNumber	Integer	No	1	Le numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	Integer	No	10	Le nombre d'entrées à renvoyer par page. Valeurs valides : de 1 à 50. Valeur par défaut : 10.
CenId	String	Yes	cen-j3jzhw1zpau2km****	L'ID de l'instance CEN.
TransitRouterId	String	No	tr-uf654ttymmljlvh2x****	L'ID du routeur de transit.
RegionId	String	No	ap-southeast-2	L'ID de la région où le routeur de transit est déployé. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente.
Tag.N.Key	String	No	TagKey	Les clés de tag des ressources. Les clés de tag ne peuvent pas être une chaîne vide. Elles peuvent comporter jusqu'à 64 caractères et ne doivent pas commencer par `acs:` ou `aliyun`. Elles ne doivent pas contenir `http://` ni `https://`. Vous pouvez spécifier au maximum 20 clés de tag.
Tag.N.Value	String	No	TagValue	Les valeurs de tag des ressources. Les valeurs de tag peuvent comporter de 0 à 128 caractères et ne doivent pas commencer par `aliyun` ou `acs:`. Elles ne doivent pas contenir `http://` ni `https://`. Chaque clé de tag possède une valeur de tag unique. Vous pouvez spécifier au maximum 20 valeurs de tag par appel.

Paramètres de réponse

Parameter	Type	Example	Description
PageSize	Integer	10	Le nombre d'entrées renvoyées par page.
RequestId	String	68521297-5FA6-46CB-B4EB-658F1C68C8CC	L'ID de la requête.
PageNumber	Integer	1	Le numéro de la page renvoyée.
TotalCount	Integer	1	Le nombre total d'entrées renvoyées.
TransitRouters	Array of TransitRouter		Une liste de routeurs de transit.
CreationTime	String	2021-03-15T09:39Z	L'heure de création du routeur de transit. L'heure suit la norme ISO8601 au format `YYYY-MM-DDThh:mmZ`. L'heure est affichée en UTC.
Type	String	Enterprise	L'édition du routeur de transit. Valeurs valides : Enterprise : Édition améliorée Basic : Édition de base
Status	String	Active	L'état du routeur de transit. Valeurs valides : Creating : Le routeur de transit est en cours de création. Active : Le routeur de transit est disponible. Modifying : Le routeur de transit est en cours de modification. Deleting : Le routeur de transit est en cours de suppression. Upgrading : Le routeur de transit est en cours de mise à niveau.
TransitRouterId	String	tr-bp1su1ytdxtataupl****	L'ID du routeur de transit.
TransitRouterDescription	String	testdesc	La description du routeur de transit.
TransitRouterName	String	testname	Le nom du routeur de transit.
CenId	String	cen-j3jzhw1zpau2km****	L'ID de l'instance CEN.
AliUid	Long	1210123456123456	L'ID du compte Alibaba Cloud auquel appartient l'instance CEN.
RegionId	String	ap-southeast-2	L'ID de la région où le routeur de transit est déployé.
SupportMulticast	Boolean	false	Indique si le multicast est activé pour le routeur de transit. Valeurs valides : true : activé false : désactivé
TransitRouterCidrList	Array of TransitRouterCidrList		Les informations relatives au bloc CIDR du routeur de transit.
Cidr	String	192.168.1.0/24	Le bloc CIDR du routeur de transit.
Name	String	CIDRname	Le nom du bloc CIDR.
Description	String	CIDRdesc	La description du bloc CIDR.
TransitRouterCidrId	String	cidr-46p5ceg21e8152****	L'ID du bloc CIDR.
PublishCidrRoute	Boolean	true	Indique s'il faut autoriser le système à ajouter automatiquement le bloc CIDR à la table de routage du routeur de transit. true : oui Une valeur true indique qu'après la création d'une connexion VPN privée et l'activation de l'apprentissage des routes pour la connexion VPN, le système ajoute automatiquement une route null à la table de routage du routeur de transit auquel la connexion VPN est attachée. Le bloc CIDR de destination de la route null correspond au bloc CIDR du routeur de transit. Le bloc CIDR du routeur de transit fait référence au bloc CIDR à partir duquel les adresses IP de passerelle sont allouées aux connexions IPsec-VPN. La route null est annoncée uniquement à la table de routage du routeur de bordure virtuelle (VBR) connecté au routeur de transit. false : non
Tags	Array of Tag		Une liste de tags.
Key	String	TagKey	La clé de tag.
Value	String	TagValue	La valeur de tag.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=ListTransitRouters
&PageNumber=1
&PageSize=10
&CenId=cen-j3jzhw1zpau2km****
&TransitRouterId=tr-uf654ttymmljlvh2x****
&RegionId=ap-southeast-2
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTransitRoutersResponse>
    <PageSize>10</PageSize>
    <RequestId>68521297-5FA6-46CB-B4EB-658F1C68C8CC</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <TransitRouters>
        <CreationTime>2021-03-15T09:39Z</CreationTime>
        <Type>Enterprise</Type>
        <Status>Active</Status>
        <TransitRouterId>tr-bp1su1ytdxtataupl****</TransitRouterId>
        <TransitRouterDescription>testdesc</TransitRouterDescription>
        <TransitRouterName>testname</TransitRouterName>
        <CenId>cen-j3jzhw1zpau2km****</CenId>
        <AliUid>1210123456123456</AliUid>
        <RegionId>ap-southeast-2</RegionId>
        <SupportMulticast>false</SupportMulticast>
        <TransitRouterCidrList>
            <Cidr>192.168.1.0/24</Cidr>
            <Name>CIDRname</Name>
            <Description>CIDRdesc</Description>
            <TransitRouterCidrId>cidr-46p5ceg21e8152****</TransitRouterCidrId>
            <PublishCidrRoute>true</PublishCidrRoute>
        </TransitRouterCidrList>
    </TransitRouters>
</ListTransitRoutersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "68521297-5FA6-46CB-B4EB-658F1C68C8CC",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "TransitRouters" : [ {
    "CreationTime" : "2021-03-15T09:39Z",
    "Type" : "Enterprise",
    "Status" : "Active",
    "TransitRouterId" : "tr-bp1su1ytdxtataupl****",
    "TransitRouterDescription" : "testdesc",
    "TransitRouterName" : "testname",
    "CenId" : "cen-j3jzhw1zpau2km****",
    "AliUid" : 1210123456123456,
    "RegionId" : "ap-southeast-2",
    "SupportMulticast" : false,
    "TransitRouterCidrList" : [ {
      "Cidr" : "192.168.1.0/24",
      "Name" : "CIDRname",
      "Description" : "CIDRdesc",
      "TransitRouterCidrId" : "cidr-46p5ceg21e8152****",
      "PublishCidrRoute" : true
    } ]
  } ]
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.