DescribeRouteEntryList - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Avant d'appeler l'opération DeleteRouteEntry pour supprimer une route, utilisez cette opération afin d'interroger le saut suivant de la route à supprimer.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
RegionId	String	Yes	cn-hangzhou	ID de région de la table de routage. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
RouteTableId	String	Yes	vtb-bp1r9pvl4xen8s9ju****	ID de la table de routage.
RouteEntryId	String	No	rte-bp1mnnr2al0naomnp****	ID de la route à interroger.
DestinationCidrBlock	String	No	192.168.2.0/24	Bloc CIDR de destination de la route. Les blocs CIDR IPv4 et IPv6 sont pris en charge.
RouteEntryName	String	No	abc	Nom de la route. Le nom doit comporter entre 1 et 128 caractères et ne peut pas commencer par `http://` ou `https://`.
IpVersion	String	No	ipv4	Version IP. Valeurs possibles : ipv4 ipv6
RouteEntryType	String	No	System	Type de route. Valeurs possibles : Custom System BGP CEN
NextHopId	String	No	vpn-bp10zyaph5cc8b7c7****	ID du saut suivant.
NextHopType	String	No	Instance	Type du saut suivant. Valeurs possibles : Instance (par défaut) : instance Elastic Compute Service (ECS) HaVip : adresse IP virtuelle à haute disponibilité (HAVIP) VpnGateway : passerelle VPN NatGateway : passerelle NAT NetworkInterface : interface réseau élastique secondaire (ENI) RouterInterface : interface de routeur IPv6Gateway : passerelle IPv6 Attachment : routeur de transit
MaxResult	Integer	No	10	Nombre d'entrées à renvoyer par page. Valeurs possibles : 1 à 100. Valeur par défaut : 10.
NextToken	String	No	FFmyTO70tTpLG6I3FmYAXGKPd****	Jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Valeurs possibles : Ne spécifiez pas ce paramètre pour la première requête. Pour envoyer une requête suivante, définissez ce paramètre sur la valeur NextToken renvoyée par le dernier appel.
Action	String	Yes	DescribeRouteEntryList	Opération à effectuer. Définissez la valeur sur DescribeRouteEntryList.
ServiceType	String	No	TR	Indique si la route est hébergée. Si vous laissez le paramètre vide, la route n'est pas hébergée. Si vous définissez la valeur sur TR, la route est hébergée par un routeur de transit.
DestCidrBlockList.N	String	No	192.168.0.0/24	Blocs CIDR de destination de la route. Vous pouvez spécifier au maximum 20 blocs CIDR de destination.

Paramètres de réponse

Parameter	Type	Example	Description
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	La valeur renvoyée de NextToken est un jeton de pagination utilisable dans la requête suivante pour récupérer une nouvelle page de résultats. Valeurs possibles : Si NextToken est vide, il n'y a pas de page suivante. Si NextToken n'est pas vide, utilisez sa valeur dans la requête suivante pour récupérer une nouvelle page de résultats.
RequestId	String	14A07460-EBE7-47CA-9757-12CC4761D47A	ID de la requête.
RouteEntrys	Array of RouteEntry		Informations sur la route.
RouteEntry
Status	String	Available	État de la route. Valeurs possibles : Pending Available Modifying
Type	String	System	Type de route. Valeurs possibles : Custom System BGP CEN
IpVersion	String	ipv4	Version IP. Valeurs possibles : ipv4 ipv6
Description	String	RouteEntryDescription	Description de la route.
RouteEntryName	String	aaa	Nom de la route.
DestinationCidrBlock	String	192.168.2.0/24	Bloc CIDR de destination de la route.
RouteEntryId	String	rte-bp1mnnr2al0naomnp****	ID de la route.
RouteTableId	String	vtb-bp15w5q90d2rk3bww****	ID de la table de routage.
GmtModified	String	2022-05-09T03:00:07Z	Heure de modification de la route. L'heure est affichée au format `YYYY-MM-DDThh:mm:ssZ` en UTC.
NextHops	Array of NextHop		Informations sur le saut suivant.
NextHop
NextHopRegionId	String	cn-hangzhou	ID de région du saut suivant. Remarque Ce paramètre est renvoyé si le type de saut suivant est défini sur RouterInterface.
Weight	Integer	100	Poids de la route. Remarque Ce paramètre est renvoyé si le type de saut suivant est défini sur RouterInterface.
NextHopId	String	vpn-bp10zyaph5cc8b7c7****	ID du saut suivant.
Enabled	Integer	1	Indique si la route est disponible. Valeurs possibles : 0 : indisponible 1 : disponible Remarque Ce paramètre est renvoyé si le type de saut suivant est défini sur RouterInterface.
NextHopType	String	Instance	Type du saut suivant. Valeurs possibles : Instance : instance ECS HaVip : HAVIP VpnGateway : passerelle VPN NatGateway : passerelle NAT NetworkInterface : ENI secondaire RouterInterface : interface de routeur IPv6Gateway : passerelle IPv6 Attachment : routeur de transit
NextHopRelatedInfo	Object		Informations sur le saut suivant.
InstanceId	String	vpc-bp1t36rn9l53iwbsf****	ID de l'instance associée au saut suivant.
InstanceType	String	VPC	Type de l'instance associée au saut suivant. Valeurs possibles : VPC : VPC VBR : VBR PCONN : circuit Express Connect
RegionId	String	ch-hangzhou	ID de région de l'instance associée au saut suivant.
ServiceType	String	TR	Indique si la route est hébergée. Si le paramètre est vide, la route n'est pas hébergée. Si TR est renvoyé, la route est hébergée par un routeur de transit.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?RegionId=cn-hangzhou
&RouteTableId=vtb-bp1r9pvl4xen8s9ju****
&RouteEntryId=rte-bp1mnnr2al0naomnp****
&DestinationCidrBlock=192.168.2.0/24
&RouteEntryName=abc
&IpVersion=ipv4
&RouteEntryType=System
&NextHopId=vpn-bp10zyaph5cc8b7c7****
&NextHopType=Instance
&MaxResult=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&Action=DescribeRouteEntryList
&ServiceType=TR
&DestCidrBlockList=["192.168.0.0/24"]
&Common request parameters

Exemples de réponses réussies

XML format

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

<DescribeRouteEntryListResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <RouteEntrys>
        <Status>Available</Status>
        <Type>Custom</Type>
        <IpVersion>ipv4</IpVersion>
        <Description>RouteEntryDescription</Description>
        <RouteEntryName>aaa</RouteEntryName>
        <DestinationCidrBlock>192.168.2.0/24</DestinationCidrBlock>
        <RouteEntryId>rte-bp1mnnr2al0naomnp****</RouteEntryId>
        <RouteTableId>vtb-bp15w5q90d2rk3bww****</RouteTableId>
        <GmtModified>2022-05-09T03:00:07Z</GmtModified>
        <NextHops>
            <NextHopRegionId>cn-hangzhou</NextHopRegionId>
            <Weight>100</Weight>
            <NextHopId>vpn-bp10zyaph5cc8b7c7****</NextHopId>
            <Enabled>1</Enabled>
            <NextHopType>Instance</NextHopType>
            <NextHopRelatedInfo>
                <InstanceId>vpc-bp1t36rn9l53iwbsf****</InstanceId>
                <InstanceType>VPC</InstanceType>
                <RegionId>ch-hangzhou</RegionId>
            </NextHopRelatedInfo>
        </NextHops>
        <ServiceType>TR</ServiceType>
    </RouteEntrys>
</DescribeRouteEntryListResponse>

JSON format

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

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "RouteEntrys" : [ {
    "Status" : "Available",
    "Type" : "Custom",
    "IpVersion" : "ipv4",
    "Description" : "RouteEntryDescription",
    "RouteEntryName" : "aaa",
    "DestinationCidrBlock" : "192.168.2.0/24",
    "RouteEntryId" : "rte-bp1mnnr2al0naomnp****",
    "RouteTableId" : "vtb-bp15w5q90d2rk3bww****",
    "GmtModified" : "2022-05-09T03:00:07Z",
    "NextHops" : [ {
      "NextHopRegionId" : "cn-hangzhou",
      "Weight" : 100,
      "NextHopId" : "vpn-bp10zyaph5cc8b7c7****",
      "Enabled" : 1,
      "NextHopType" : "Instance",
      "NextHopRelatedInfo" : {
        "InstanceId" : "vpc-bp1t36rn9l53iwbsf****",
        "InstanceType" : "VPC",
        "RegionId" : "ch-hangzhou"
      }
    } ],
    "ServiceType" : "TR"
  } ]
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	OperationFailed.QueryCenEntry	Operation is denied because getting CEN route entry has failed.	Le système n'a pas pu interroger les routes CEN.
400	OperationDenied.UseGatewayRouteEntryQueryInterface	Use listGatewayRouteTableEntries to describe gateway route entries.	Pour interroger les routes d'une table de routage de passerelle, appelez l'opération listGatewayRouteTableEntries.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.