接口功能介绍
查询启用安全引流的智能网关
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
pageNo和pageSize从1开始，不能小于1
URI
GET /v4/sdwan/edge-safty-flow/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNo | 否 | Integer | 页码 | 1 | |
| pageSize | 否 | Integer | 每页记录数目 | 10 | |
| search | 否 | String | 模糊查询 | edge-001 | |
| instanceID | 是 | String | 安全引流实例ID | 42c77ac7-1a2f-47ee-8fcc-6302a6a1e34a |
请求参数
请求header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 总数 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 | |
| result | 否 | Array of Objects | 列表 | result |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| customerID | 否 | String | customer的id | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| edgeID | 否 | String | 智能网关ID | 2893f150-19b5-11eb-8e79-824da1059800 | |
| edgeName | 否 | String | 智能网关名称 | edge-001 | |
| edgeZone | 否 | String | 智能网关所在区域 | guizhou | |
| status | 否 | String | 本参数表示状态 取值范围： enable： 启用 disable： 未启用 |
enable | |
| sdwanID | 否 | String | sdwan ID | 9e6cb770-4b05-11ee-bfof-525400af7402 | |
| sdwanName | 否 | String | sdwan名称 | sdwan-001 | |
| fwID | 否 | String | 防火墙ID | 1 | |
| fwIP | 否 | String | 防火墙IP | 100.127.255.178 |
请求示例
请求url
/v4/sdwan/edge-safty-flow/list?instanceID=42c77ac7-1a2f-47ee-8fcc-6302a6a1e34a
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"result": [
{
"customerID": "be012e8f-ea32-4a2c-89da-7db35eedb334",
"edgeID": "2893f150-19b5-11eb-8e79-824da1059800",
"edgeName": "edge-001",
"edgeZone": "guizhou",
"status": "enable",
"fwID": "1",
"fwIp": "100.127.255.178",
"sdwanID": "9e6cb770-4b05-11ee-bfof-525400af7402",
"sdwanName": "sdwan-001"
}
]
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
