最近更新时间：2024.04.22 11:09:42
首次发布时间：2021.07.29 14:11:54
调用 DescribeRouteEntryList 接口，在指定路由表内查询满足指定条件的路由条目。
传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的路由条目，若没有符合条件的路由条目，则返回空值。
若请求参数非必选参数均未传入，则返回指定路由表的所有路由条目。
参数名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeRouteEntryList | 要执行的操作，取值：DescribeRouteEntryList。 |
| Version | String | 是 | 2020-04-01 | API版本信息，取值为：2020-04-01。 |
RouteTableId | String | 是 | vtb-2fdzao4h726f45oxruw****** | 待查询路由表的ID。 |
RouteEntryType | String | 否 | Custom | 路由条目的类型，固定传入 说明 传入任意非必填参数时，必须传入本参数。 |
| RouteEntryId | String | 否 | rte-3tj9gw2pwq3vj0****** | 路由条目的ID。 |
| RouteEntryName | String | 否 | Test route entry | 路由条目的名称。 |
NextHopType | String | 否 | NetworkInterface | 路由条目的下一跳的类型。取值如下：
说明 高可用虚拟IP、IPv6网关、云连接器正在邀测中，如需试用，请联系客户经理。 |
| NextHopId | String | 否 | eni-2fdzbqxfwrt345oxruv****** | 路由条目的下一跳资源ID。 请根据下一跳类型，传入正确的资源ID。 |
| DestinationCidrBlock | String | 否 | 8.XX.XX.1/22 | 路由条目的目标网段。 |
DestinationPrefixListId | String | 否 | route-prefixlist-1 | 前缀列表的ID。 说明 前缀列表正在邀测中，如需试用，请联系客户经理。 |
PageNumber | Integer | 否 | 1 | 列表的页码。默认值为1。 说明 本参数即将下线，建议您使用 |
PageSize | Integer | 否 | 20 | 分页查询时每页的行数。最大值为100，默认值为20。 说明 本参数即将下线，建议您使用 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a**** | 分页查询凭证，用于标记分页的位置。
|
| MaxResults | Integer | 否 | 50 | 查询的数量，默认为 10，最大为100。 |
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 2021062415303301022514515207C4**** | 请求ID。 |
TotalCount | Integer | 2 | 符合条件的路由条目总数。 说明 本参数即将下线，使用 |
PageNumber | Integer | 1 | 当前页码。 说明 本参数即将下线，建议您使用 |
PageSize | Integer | 10 | 当前分页的行数。 说明 本参数即将下线，建议您使用 |
NextToken | String | caeba0bbb2be03f84eb48b699f0a**** | 本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。 |
| RouteEntries | Array of Struct | - | 路由条目的详细信息。具体请参见下表“ RouteEntries结构 ”。 |
RouteEntries结构
参数名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Description | String | This is the first route | 路由条目描述。 |
| DestinationCidrBlock | String | 8.XX.XX.0/16 | 路由条目的目标网段。 |
| RouteEntryId | String | rte-3tj9gw2pwq3vj****** | 路由条目ID。 |
| RouteEntryName | String | test-route | 路由条目名称。 |
| RouteTableId | String | vtb-fadfgegg****** | 路由条目所属路由表的ID。 |
Status | String | Available | 路由规则状态。
|
Type | String | Custom | 路由条目类型。
|
| VpcId | String | vpc-3tj9fo0uqy3vj0****** | 路由条目所属私有网络的ID。 |
| NextHopId | String | eni-2fdzbqxfwrt345oxru****** | 下一跳资源的ID。 |
| NextHopType | String | NetworkInterface | 下一跳类型。 |
| PrefixListCidrBlocks | List | ["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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidPage.Malformed | The specified page is malformed. | 指定的分页参数不合法。 |
| 400 | InvalidMaxResults.Malformed | The specified parameter MaxResults is malformed. | 查询数量不合法。 |
| 400 | InvalidNextToken.Malformed | The specified parameter NextToken is invalid. | 查询 NextToken 不合法。 |
| 400 | InvalidCidr.Malformed | The specified cidr block is malformed. | 指定的网段格式不合法。 |
| 404 | InvalidRouteTable.NotFound | The specified route table does not exist. | 指定的路由表不存在。 |
| 404 | InvalidRouteNextHop.NotFound | The specified next hop does not exist. | 指定的下一跳不存在。 |