接口功能介绍
查询路由表规则列表
接口约束
URI
GET /v4/vpc/route-table/list-rules
请求参数
Query 参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
regionID | String | 是 | 区域id | |
routeTableID | String | 是 | 路由表 id | rtb-xxxx |
pageNumber | Integer | 否 | 列表的页码,默认值为 1。 | 1 |
pageNo | Integer | 否 | 列表的页码,默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
pageSize | Integer | 否 | 分页查询时每页的行数,最大值为 50,默认值为 10。 | 10 |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 |
message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
errorCode | String | statusCode为900时为业务细分错误码,三段式:product.module.code; statusCode为800时为SUCCESS | SUCCESS |
totalCount | Integer | 列表条目数 | 20 |
currentCount | Integer | 分页查询时每页的行数。 | 4 |
totalPage | Integer | 总页数 | 5 |
returnObj | Array of Objects | 返回结果 | 见下表 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
nextHopID | String | 是 | 下一跳设备 id |
nextHopType | String | 是 | vpcpeering(对等连接) / havip(虚拟IP) / bm(弹性裸金属服务器)/ vm(云主机) / natgw(NAT网关)/ igw6(IPv6网关) / dc(专线网关) / ticc(云间高速) / vpngw(VPN网关) / enic(弹性网卡) |
destination | String | 是 | 无类别域间路由 |
ipVersion | Integer | 是 | 4 表示 ipv4, 6 表示 ipv6 |
description | String | 是 | 规则描述 |
routeRuleID | String | 是 | 路由规则 id |
请求示例
GET /v4/vpc/route-table/list-rules?regionID=xxxx&routeTableID=xxxx
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [{
"nextHopID": "Xxx",
"nextHopType": "havip",
"ipVersion": 4,
"description": "xxxx",
"destination": "192.168.0.1/32",
"routeRuleID": "route-rule-xxx"
}],
"currentCount": 3,
"totalCount": 3,
"totalPage": 1
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。