You need to enable JavaScript to run this app.
导航

DescribeRouteTableList

最近更新时间2024.01.10 10:41:29

首次发布时间2021.07.29 14:11:54

调用 DescribeRouteTableList 接口,查询满足指定条件的路由表。

调用说明

  • 传入多个请求参数,按照传入的参数进行查询,返回符合所有条件的路由表,若没有符合条件的路由表,则返回空值。

  • 若请求参数非必选参数均未传入,则按照当前登录账号查询,返回当前账号下的所有路由表。

调试

请求参数

参数名称
类型
是否必选
示例值
描述
ActionStringDescribeRouteTableList要执行的操作,取值:DescribeRouteTableList。
VersionString2020-04-01API版本信息,取值为:2020-04-01。

VpcId

String

vpc-2fdz8g5nruzuo5oxru*******

路由表所属VPC的ID。
您可以调用 DescribeVpcs 接口,查询VPC的ID。

RouteTableIdStringvtb-2fdzao4h726f45******要查询的路由表的ID。
RouteTableNameStringtest-route-table要查询的路由表名称。
ProjectNameStringdefault路由表所属项目的名称。

PageNumber

Integer

1

列表的页码。默认值为1。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

20

分页查询时每页的行数。最大值为100,默认值为20。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

分页查询凭证,用于标记分页的位置。

  • 不填则从头开始查询。
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。
MaxResultsInteger50查询的数量,默认为 10,最大为100。

返回数据

参数名称
类型
示例值
描述
RequestIdString2021062415303301022514515207C4****请求ID。

TotalCount

Integer

2

符合条件的路由表总数。

说明

本参数即将下线,使用NextTokenMaxResults分页查询时,此参数无意义。

PageNumber

Integer

1

当前页码。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

PageSize

Integer

10

当前分页的行数。

说明

本参数即将下线,建议您使用NextTokenMaxResults进行分页查询。

NextToken

String

caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。

RouterTableListArray of Struct-路由表的详细信息。具体请参见下表“ RouterTableList结构 ”。

RouterTableList结构

参数名称
类型
示例值
描述
AccountIdString200000****路由表所属账号的ID。
VpcIdStringvpc-2fdz8g5nruzuo5oxru****路由表所属的VPC ID。
VpcNameStringtestVPC的名称。
RouteTableIdStringvtb-2fdzao4h726f45******路由表ID。
RouteTableNameStringTest-route-table路由表名称。
DescriptionStringTest route table路由表描述信息。
RouteTableTypeStringCustom路由表的类型:
  • Custom:自定义路由表。
  • System:系统路由表。
  • SubnetIdsArray["subnet-2fdzbgudy248w5o****","subnet-2fdzaou4liw3k5oxruv****"]路由表绑定的子网列表。
    ProjectNameStringdefault路由表所属项目的名称。
    CreationTimeString2021-09-01T19:38:31+08:00创建路由表的时间。
    UpdateTimeString2021-09-01T19:38:31+08:00更新路由表的时间。

    请求示例

    GET /?Action=DescribeRouteTableList&Version=2020-04-01&VpcId=vpc-2fdz8g5nruzuo5oxru*******	  HTTP/1.1
    Host: open.volcengineapi.com
    Service: vpc
    Region: cn-beijing
    

    返回示例

    {
        "ResponseMetadata": {
            "RequestId": "2021062415303301022514515207C4****",
            "Action": "DescribeRouteTableList",
            "Version": "2020-04-01",
            "Service": "vpc",
            "Region": "cn-beijing"
        },
        "Result": {
            "RequestId": "2021062415303301022514515207C4****",
            "TotalCount": 2,
            "PageNumber": 1,
            "PageSize": 20,
            "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
            "RouterTableList": [
                {
                    "RouteTableId": "vtb-2ff3bq0c10e0w5oxruvx6****",
                    "RouteTableName": "test",
                    "RouteTableType": "System",
                    "VpcId": "vpc-2ff3bpyczwc1s5oxruwe8****",
                    "SubnetIds": [
                        "subnet-1g0esbs70pfr48ibuxwpu****"
                    ],
                    "VpcName": "test",
                    "CreationTime": "2021-09-01T19:38:31+08:00",
                    "UpdateTime": "2021-09-01T19:38:31+08:00",
                    "AccountId": "200000****",
                    "Description": "system route table created by vpc"
                }
            ]
        }
    }
    

    错误码

    此处仅展示当前API的错误码,更多错误码请参见公共错误码

    HttpCode
    错误码
    错误信息
    描述
    400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
    400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
    400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。