查询路由策略
接口功能介绍
查询路由策略
接口约束
无
URI
GET /v4/ec/route-map/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cgwID | 是 | String | 云网关ID | 7c84cfa9-a997-4281-af8a-3c765c25d0be | |
| rtbID | 是 | String | 路由表ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| routeMapName | 否 | String | 路由策略名字 | policy_23idc4 | |
| routeMapID | 否 | String | 路由策略ID | bc9a70eb-28d7-4032-9510-1bea00192f34 |
请求参数
请求头header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800:成功 900:失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| traceID | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentCount | 否 | Integer | 当前页记录数 | 3 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| results | 否 | Array of Objects | 返回查询结果，Json数组 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ecID | 否 | String | 云间高速实例ID | 82c40584-fe8f-49b0-9e09-ef915caeee10 | |
| cgwID | 否 | String | 云网关ID | 7c84cfa9-a997-4281-af8a-3c765c25d0be | |
| rtbID | 是 | String | 路由表ID | 55450584-fe8f-49b0-9e09-ef915caeee10 | |
| routeMapID | 否 | String | 路由策略ID | bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| routeMapName | 否 | String | 路由策略名字 | route-map-23idc4 | |
| priority | 否 | Integer | 优先级，取值范围1-100，越小优先级越高，同向互异 | 100 | |
| direction | 否 | Integer | 策略作用方向 取值范围 0：入方向 1：出方向 |
0 | |
| action | 否 | Integer | 策略动作（当前仅支持 0：拒绝） 取值范围 0：拒绝 1：放行 |
0 | |
| srcInsList | 否 | String | 源实例ID列表（如vpcID, cdaID），通过","分隔 当direction为0时必填 |
bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| dstInsList | 否 | String | 目的实例ID列表（如vpcID, cdaID），通过","分隔 当direction为1时必填 |
bc9a70eb-28d7-4032-9510-1bea00192f34 | |
| CIDRs | 否 | String | 路由前缀列表，通过","分隔 如未填写则拒绝（或放行） 所有全部网段 |
192.168.1.0/24, 172.16.0.1/24 | |
| routeMapDescription | 否 | String | 描述信息 | description | |
| CIDRSize | 否 | Integer | 路由前缀数量 | 1000 |
请求示例
请求url
v4/ec/route-map/query?cgwID=82c40584-fe8f-49b0-9e09-ef915caeee10&rtbID=55450584-fe8f-49b0-9e09-ef915caeee10
请求头header
无
请求体body
无
响应示例
{
"description":"",
"errorCode":"",
"message":"",
"statusCode":800,
"traceID":"2062f2ab-6722-4273-9850-997b4398ddb5",
"returnObj":{
"totalCount":1,
"totalPage":1,
"currentCount":1,
"results":[
{
"ecID": "82c40584-fe8f-49b0-9e09-ef915caeee10",
"cgwID": "7c84cfa9-a997-4281-af8a-3c765c25d0be",
"rtbID": "55450584-fe8f-49b0-9e09-ef915caeee10",
"routeMapID": "bc9a70eb-28d7-4032-9510-1bea00192f34",
"routeMapName": "route-map-23idc4",
"priority": 100,
"direction": 0,
"action": 0,
"srcInsList": "bc9a70eb-28d7-4032-9510-1bea00192f34",
"dstInsList": "",
"CIDRs": "",
"routeMapDescription": "description",
"CIDRSize": 10
}
]
}
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.RouteMAPEc.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
