All Products
Search
Document Center

Virtual Private Cloud:DescribeRouteTableList

Last Updated:Feb 24, 2025

Queries route tables.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeRouteTableListlist
*RouteTable
acs:vpc:{#regionId}:{#accountId}:routetable/*
  • vpc:VRouter
  • vpc:VBR
none

Request parameters

ParameterTypeRequiredDescriptionExample
RouterTypestringNo

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

  • VRouter (default): a vRouter
  • VBR: a VBR
VRouter
RouterIdstringNo

The ID of vRouter to which the route table belongs.

vrt-bp1lhl0taikrteen8****
VpcIdstringNo

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

When this parameter is set, the value of RouterType is automatically assigned to VRouter.

vpc-bp15zckdt37pq72****
RouteTableIdstringNo

The ID of the route table.

vtb-bp145q7glnuzdvzu2****
RouteTableNamestringNo

The name of the route table.

doctest
PageNumberintegerNo

The number of the returned page. Default value: 1.

1
PageSizeintegerNo

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

10
ResourceGroupIdstringNo

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

rg-acfmxazb4ph****
RegionIdstringYes

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

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

ap-southeast-6
Tagarray<object>No

The tags of the resource.

objectNo

The tags of the resource.

KeystringNo

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

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

FinanceDept
ValuestringNo

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

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

FinanceJoshua
RouteTableTypestringNo

The type of the route table.

  • System
  • Custom
System

Response parameters

ParameterTypeDescriptionExample
object

The details of the route table.

RequestIdstring

The request ID.

DC668356-BCB4-42FD-9BC3-FA2B2E04B634
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of entries returned.

1
RouterTableListarray<object>

The detailed information about the route tables.

RouterTableListTypeobject

The details of the route table.

VpcIdstring

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

vpc-bp15zckdt37pq72****
CreationTimestring

The time when the route table was created.

2021-08-22T10:40:25Z
Statusstring

The status of the route table. Valid values:

  • Pending
  • Available
  • Deleting
Available
RouterIdstring

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

vrt-bp1lhl0taikrteen8****
AssociateTypestring

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

  • VSwitch: vSwitch
  • Gateway: IPv4 gateway
VSwitch
RouteTableIdstring

The ID of the route table.

vtb-bp145q7glnuzdvzu2****
OwnerIdlong

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

253460731706911258
Descriptionstring

The information about the route table.

This is Route Table.
RouteTableTypestring

The type of the route table. Valid values:

  • Custom
  • System
System
ResourceGroupIdstring

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

rg-acfmxazb4ph****
RouterTypestring

The type of the vRouter to which the route table belongs. Valid values:

  • VRouter: a vRouter.

  • VBR: a VBR.

VRouter
RouteTableNamestring

The name of the route table.

doctest
Tagsarray<object>

The tags.

Tagobject

The tags.

Keystring

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

type
Valuestring

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

ingress
VSwitchIdsarray

The vSwitch IDs.

VSwitchIdstring

The vSwitch IDs.

vsw-bp12mw1f8k3jgygk9****
GatewayIdsarray

The detailed information about the IPv4 gateway.

GatewayIdsstring

The detailed information about the IPv4 gateway.

ipv4gw-5tsnc6s4ogsedtp3k****
RoutePropagationEnableboolean

Whether to receive the propagation routes. Valid Values:

  • true: received.

  • false: not received.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "DC668356-BCB4-42FD-9BC3-FA2B2E04B634",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 1,
  "RouterTableList": {
    "RouterTableListType": [
      {
        "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": {
          "Tag": [
            {
              "Key": "type",
              "Value": "ingress"
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp12mw1f8k3jgygk9****"
          ]
        },
        "GatewayIds": {
          "GatewayIds": [
            "ipv4gw-5tsnc6s4ogsedtp3k****"
          ]
        },
        "RoutePropagationEnable": true
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidTagKeyThe tag keys are not valid.The tag index is invalid.
400InvalidTagValueThe tag values are not valid.The tag value is invalid.
400IellgalParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.The specified parameter OwnerAccount is illegal.
403ForbbidenUser not authorized to operate on the specified resource.User not authorized to operate on the specified resource.
403Abs.InvalidPayTypeSpecified pay type is not valid.-
403Abs.InstanceNotExistSpecified instance not exist.-
403Abs.ForbiddenSpecified instance cannot change pay type.-
403Abs.InvalidPayPeriodSpecified pay period not valid.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-05The Error code has changed. The response structure of the API has changedView Change Details
2023-11-27The Error code has changed. The request parameters of the API has changedView Change Details
2023-08-14The Error code has changedView Change Details
2023-08-03API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details