You need to enable JavaScript to run this app.
导航
DescribeRouteEntryList
最近更新时间:2024.05.17 08:35:45首次发布时间:2021.07.29 14:11:54

调用 DescribeRouteEntryList 接口,在指定路由表内查询满足指定条件的路由条目。

调用说明

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

  • 若请求参数非必选参数均未传入,则返回指定路由表的所有路由条目。

调试

请求参数

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

RouteTableId

String

vtb-2fdzao4h726f45oxruw******

待查询路由表的ID。
您可以调用 DescribeRouteTableList 接口,查询路由表的ID。

RouteEntryType

String

Custom

路由条目的类型,固定传入Custom

说明

传入任意非必填参数时,必须传入本参数。

RouteEntryIdStringrte-3tj9gw2pwq3vj0******路由条目的ID。
RouteEntryNameStringTest route entry路由条目的名称。

NextHopType

String

NetworkInterface

路由条目的下一跳的类型。取值如下:

  • Instance:ECS实例。
  • HaVip:高可用虚拟IP。
  • NetworkInterface:辅助网卡。
  • NatGW:NAT网关。
  • VpcPeer:云企业网(同地域)。
  • RegionGW:云企业网(跨地域)。
  • TransitRouter:中转路由器。
  • IPv6GW:IPv6网关。
  • CloudConnector:云连接器。

说明

高可用虚拟IP、IPv6网关、云连接器正在邀测中,如需试用,请联系客户经理。

NextHopIdStringeni-2fdzbqxfwrt345oxruv******路由条目的下一跳资源ID。
请根据下一跳类型,传入正确的资源ID。
DestinationCidrBlockString8.XX.XX.1/22路由条目的目标网段。
DestinationPrefixListIdStringroute-prefixlist-1前缀列表的ID。

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调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。

RouteEntriesArray of Struct-路由条目的详细信息。具体请参见下表“ RouteEntries结构 ”。

RouteEntries结构

参数名称
类型
示例值
描述
DescriptionStringThis is the first route路由条目描述。
DestinationCidrBlockString8.XX.XX.0/16路由条目的目标网段。
RouteEntryIdStringrte-3tj9gw2pwq3vj******路由条目ID。
RouteEntryNameStringtest-route路由条目名称。
RouteTableIdStringvtb-fadfgegg******路由条目所属路由表的ID。

Status

String

Available

路由规则状态。

  • Pending:配置中
  • Available:可用

Type

String

Custom

路由条目类型。

  • Custom:自定义路由条目
  • System:系统路由条目
VpcIdStringvpc-3tj9fo0uqy3vj0******路由条目所属私有网络的ID。
NextHopIdStringeni-2fdzbqxfwrt345oxru******下一跳资源的ID。
NextHopTypeStringNetworkInterface下一跳类型。
PrefixListCidrBlocksList["8.XX.XX.0/16","16.XX.XX.0/16"]前缀列表的CIDR。

请求示例

GET /?Action=DescribeRouteEntryList&Version=2020-04-01&RouteTableId=vtb-2fdzao4h726f45oxruw****** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeRouteEntryList",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "RouteEntries": [
            {
                "RouteEntryId": "rte-2fe5z27fzsuf45oxruw95****",
                "RouteEntryName": "",
                "Type": "Custom",
                "VpcId": "vpc-3tj9fo0uqy3vj0x2****",
                "RouteTableId": "vtb-3tj9fo0uqy3vj0x2****",
                "DestinationCidrBlock": "172.XX.XX.0/16",
                "NextHopType": "Instance",
                "NextHopId": "i-3tjc4fzane3vj0x1****",
                "NextHopName": "",
                "Status": "Available",
                "Description": ""
                "PrefixListCidrBlocks": [
                    8.XX.XX.0/16,
                    16.XX.XX.0/16
                ]
            }
        ]
    }
}

错误码

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

HttpCode
错误码
错误信息
描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400InvalidMaxResults.MalformedThe specified parameter MaxResults is malformed.查询数量不合法。
400InvalidNextToken.MalformedThe specified parameter NextToken is invalid.查询 NextToken 不合法。
400InvalidCidr.MalformedThe specified cidr block is malformed.指定的网段格式不合法。
404InvalidRouteTable.NotFoundThe specified route table does not exist.指定的路由表不存在。
404InvalidRouteNextHop.NotFoundThe specified next hop does not exist.指定的下一跳不存在。