All Products
Search
Document Center

:DescribeRouteTableList

更新時間:Aug 25, 2023

Queries route tables.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

RouterType String No VRouter

The type of the router to which the route table belongs. Valid value:

  • VRouter (default)
  • VBR
RouterId String No vrt-bp1lhl0taikrteen8****

The ID of the router to which the route table belongs.

VpcId String No vpc-bp15zckdt37pq72****

The ID of the virtual private cloud (VPC) to which the route table belongs.

After this parameter is specified, the value of the RouterType parameter is automatically set to VRouter.

RouteTableId String No vtb-bp145q7glnuzdvzu2****

The ID of the route table that you want to query.

RouteTableName String No doctest

The name of the route table that you want to query.

PageNumber Integer No 1

The page number. Default value: 1.

PageSize Integer No 10

The number of entries per page. Maximum value: 50. Default value: 10.

ResourceGroupId String No rg-acfmxazb4ph****

The ID of the resource group to which the route table to be queried belongs.

Action String Yes DescribeRouteTableList

The operation that you want to perform. Set the value to DescribeRouteTableList.

RegionId String Yes ap-southeast-6

The region ID of the VPC to which the route table belongs.

You can call the DescribeRegions operation to query the most recent region list.

Tag.N.Key String No FinanceDept

The key of tag N to add to the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string.

The tag key can be at most 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

Tag.N.Value String No FinanceJoshua

The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string.

The tag value can be up to 128 characters in length, but cannot contain http:// or https://. The tag value cannot start with aliyun or acs:.

Response parameters

Parameter

Type

Example

Description

RequestId String DC668356-BCB4-42FD-9BC3-FA2B2E04B634

The request ID.

PageSize Integer 10

The number of entries per page.

PageNumber Integer 1

The page number.

TotalCount Integer 1

The total number of entries returned.

RouterTableList Array of RouterTableListType

The detailed information about the route tables.

RouterTableListType
VpcId String vpc-bp15zckdt37pq72****

The ID of the VPC to which the route table belongs.

CreationTime String 2021-08-22T10:40:25Z

The time when the route table was created.

Status String Available

The status of the route table. Valid value:

  • Pending
  • Available
  • Deleting
RouterId String vrt-bp1lhl0taikrteen8****

The ID of the router to which the route table belongs.

AssociateType String VSwitch

The type of the cloud resource with which the route table is associated. Valid values:

  • VSwitch: a vSwitch
  • Gateway: an IPv4 gateway
RouteTableId String vtb-bp145q7glnuzdvzu2****

The ID of the route table.

OwnerId Long 253460731706911258

The ID of the Alibaba Cloud account to which the route table belongs.

Description String This is Route Table.

The description of the route table.

RouteTableType String System

The type of the route table. Valid value:

  • Custom
  • System
ResourceGroupId String rg-acfmxazb4ph****

The ID of the resource group to which the route table belongs.

RouterType String VRouter

The type of the router to which the route table belongs. Valid value:

  • VRouter
  • VBR
RouteTableName String doctest

The name of the route table.

Tags Array of Tag

The tag added to the route table.

Tag
Key String type

The key of the tag that is added to the route table.

Value String ingress

The value of the tag that is added to the route table.

VSwitchIds Array of String vsw-bp12mw1f8k3jgygk9****

The vSwitch ID.

GatewayIds Array of String ipv4gw-5tsnc6s4ogsedtp3k****

The detailed information about the IPv4 gateway.

Examples

Sample requests

http(s)://[Endpoint]/?RouterType=VRouter
&RouterId=vrt-bp1lhl0taikrteen8****
&VpcId=vpc-bp15zckdt37pq72****
&RouteTableId=vtb-bp145q7glnuzdvzu2****
&RouteTableName=doctest
&PageNumber=1
&PageSize=10
&ResourceGroupId=rg-acfmxazb4ph****
&Action=DescribeRouteTableList
&RegionId=ap-southeast-6
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Sample success responses

XML format

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

<DescribeRouteTableListResponse>
    <RequestId>DC668356-BCB4-42FD-9BC3-FA2B2E04B634</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <RouterTableList>
        <VpcId>vpc-bp15zckdt37pq72****</VpcId>
        <CreationTime>2021-08-22T10:40:25Z</CreationTime>
        <Status>Available</Status>
        <RouterId>vrt-bp1lhl0taikrteen8****</RouterId>
        <AssociateType>VSwitch</AssociateType>
        <RouteTableId>vtb-bp145q7glnuzdvzu2****</RouteTableId>
        <OwnerId>253460731706911260</OwnerId>
        <Description>This is Route Table.</Description>
        <RouteTableType>System</RouteTableType>
        <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
        <RouterType>VRouter</RouterType>
        <RouteTableName>doctest</RouteTableName>
        <Tags>
            <Key>type</Key>
            <Value>ingress</Value>
        </Tags>
        <VSwitchIds>vsw-bp12mw1f8k3jgygk9****</VSwitchIds>
        <GatewayIds>ipv4gw-5tsnc6s4ogsedtp3k****</GatewayIds>
    </RouterTableList>
</DescribeRouteTableListResponse>

JSON format

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

{
  "RequestId" : "DC668356-BCB4-42FD-9BC3-FA2B2E04B634",
  "PageSize" : 10,
  "PageNumber" : 1,
  "TotalCount" : 1,
  "RouterTableList" : [ {
    "VpcId" : "vpc-bp15zckdt37pq72****",
    "CreationTime" : "2021-08-22T10:40:25Z",
    "Status" : "Available",
    "RouterId" : "vrt-bp1lhl0taikrteen8****",
    "AssociateType" : "VSwitch",
    "RouteTableId" : "vtb-bp145q7glnuzdvzu2****",
    "OwnerId" : 253460731706911260,
    "Description" : "This is Route Table.",
    "RouteTableType" : "System",
    "ResourceGroupId" : "rg-acfmxazb4ph****",
    "RouterType" : "VRouter",
    "RouteTableName" : "doctest",
    "Tags" : [ {
      "Key" : "type",
      "Value" : "ingress"
    } ],
    "VSwitchIds" : [ "vsw-bp12mw1f8k3jgygk9****" ],
    "GatewayIds" : [ "ipv4gw-5tsnc6s4ogsedtp3k****" ]
  } ]
}

Error codes

HttpCode

Error code

Error message

Description

400 InvalidTagKey The tag keys are not valid. The tag index is invalid.
400 InvalidTagValue The tag values are not valid. The tag value is invalid.

For a list of error codes, see Service error codes.