All Products
Search
Document Center

Virtual Private Cloud:DescribeRouteTableList

Last Updated:Dec 06, 2023

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.

debugging

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 type of the router to which the route table belongs. Valid values:

  • VRouter (default)
  • VBR
VRouter
RouterIdstringNo

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

vrt-bp1lhl0taikrteen8****
VpcIdstringNo

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.

vpc-bp15zckdt37pq72****
RouteTableIdstringNo

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

vtb-bp145q7glnuzdvzu2****
RouteTableNamestringNo

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

doctest
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

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

10
ResourceGroupIdstringNo

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

rg-acfmxazb4ph****
RegionIdstringYes

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.

ap-southeast-6
Tagobject []No

The tags of the resource.

KeystringNo

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

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

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
RouterTableListobject []

The detailed information about the route tables.

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 router 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: a vSwitch
  • Gateway: an 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 description of 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 router to which the route table belongs. Valid values:

  • VRouter
  • VBR
VRouter
RouteTableNamestring

The name of the route table.

doctest
Tagsobject []

The tag added to the route table.

Keystring

The key of tag N added to the resource.

type
Valuestring

The value of tag N added to the resource.

ingress
VSwitchIdsarray

The information about the vSwitches.

string

The vSwitch ID.

vsw-bp12mw1f8k3jgygk9****
GatewayIdsarray

The detailed information about the IPv4 gateway.

string

The detailed information about the IPv4 gateway.

ipv4gw-5tsnc6s4ogsedtp3k****

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****"
          ]
        }
      }
    ]
  }
}

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.The error message returned because you are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
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
2023-11-27The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: RouteTableType
2023-08-14The error codes of the API operation change.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
2023-08-03API Description Update,The error codes of the API operation change.,The input parameters of the API operation change.see changesets
Change itemChange content
API DescriptionAPI Description Update
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
    delete Error Codes: 403
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: Tag