All Products
Search
Document Center

Virtual Private Cloud:DescribeRouteTableList

Last Updated:Mar 04, 2024

Queries route tables.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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 ID of the resource group to which the route table to be queried belongs.

VRouter
RouterIdstringNo

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.

vrt-bp1lhl0taikrteen8****
VpcIdstringNo

The tags of the resource.

vpc-bp15zckdt37pq72****
RouteTableIdstringNo

The tags.

vtb-bp145q7glnuzdvzu2****
RouteTableNamestringNo

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 up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

doctest
PageNumberintegerNo

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://.

1
PageSizeintegerNo

The type of the route table.

  • System
  • Custom
10
ResourceGroupIdstringNo

The details of the route table.

rg-acfmxazb4ph****
RegionIdstringYes

The number of entries per page.

ap-southeast-6
Tagobject []No

The page number.

KeystringNo

The detailed information about the route tables.

FinanceDept
ValuestringNo

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

FinanceJoshua
RouteTableTypestringNo

The time when the route table was created.

System

Response parameters

ParameterTypeDescriptionExample
object

The status of the route table. Valid values:

  • Pending
  • Available
  • Deleting
RequestIdstring

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

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

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

  • VSwitch: vSwitch
  • Gateway: IPv4 gateway
10
PageNumberinteger

The ID of the route table.

1
TotalCountinteger

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

1
RouterTableListobject []

The description of the route table.

VpcIdstring

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

vpc-bp15zckdt37pq72****
CreationTimestring

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

  • VRouter
  • VBR
2021-08-22T10:40:25Z
Statusstring

The name of the route table.

Available
RouterIdstring

The tag added to the route table.

vrt-bp1lhl0taikrteen8****
AssociateTypestring

The tags.

VSwitch
RouteTableIdstring

The key of tag N added to the resource.

vtb-bp145q7glnuzdvzu2****
OwnerIdlong

The value of tag N added to the resource.

253460731706911258
Descriptionstring

The information about the vSwitches.

This is Route Table.
RouteTableTypestring

The ID of the vSwitch.

System
ResourceGroupIdstring

The detailed information about the IPv4 gateway.

rg-acfmxazb4ph****
RouterTypestring

The detailed information about the IPv4 gateway.

VRouter
RouteTableNamestring

The name of the route table.

doctest
Tagsobject []

The tags.

Keystring

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 up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

type
Valuestring

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://.

ingress
VSwitchIdsarray

The vSwitch IDs.

string

The vSwitch IDs.

vsw-bp12mw1f8k3jgygk9****
GatewayIdsarray

The detailed information about the IPv4 gateway.

string

The detailed information about the IPv4 gateway.

ipv4gw-5tsnc6s4ogsedtp3k****
RoutePropagationEnableboolean

Whether to receive the propagation routes. Valid Values:

  • True: The propagation route is received.

  • False: The propagation route is 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.-
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 changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Output ParametersThe response structure of the API has changed.
2023-11-27The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: RouteTableType
2023-08-14The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
2023-08-03API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tag