接口功能介绍
校验同网段
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
POST /v4/sdwan/check-cidr
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 是 | String | 站点的ID | 65768712-3890-11ed-a977-005056898fe0 | |
| checkType | 是 | String | 本参数表示校验类型 取值范围: sdwan:校验edge绑定SDWAN edge:绑定sdwan的情况下修改盒子私网网段 snat:校验snat对外服务IP |
edge | |
| sdwanID | 否 | String | SD-WAN ID ,checkType为sdwan/edge必填 | 1266efd2-5827-11ee-ba6e-525400af7402 | |
| ipv4Cidr | 否 | Array of Strings | 设备ipv4私网网段，值类型为string, checkType为edge必填 | ||
| ipv6Cidr | 否 | Array of Strings | 设备ipv6私网网段，值类型为string | ||
| snatIP | 否 | String | snat对外服务IP，checkType为snat必填 | 12.2.3.2 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Array of Objects | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeID | 否 | String | 智能网关站点ID | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| edgeName | 否 | String | 智能网关站点名称 | edge-001 | |
| dstEdgeName | 否 | String | 冲突智能网关站点名称 | edge-002 | |
| dstEdgeID | 否 | String | 冲突智能网关站点ID | ae012e8f-ea32-4a2c-89da-7db35eedb334 | |
| status | 否 | Integer | 本参数表示网段状态 取值范围: 1:重复 2:包含 |
1 |
请求示例
请求头header
无
请求体body
{
"edgeID": "be012e8f-ea32-4a2c-89da-7db35eedb334",
"checkType": "edge",
"sdwanID": "be012e8f-ea32-4a2c-89da-7db35eedb334",
"ipv4Cidr": ["12.3.4.0/24"],
"ipv6Cidr": ["1234::12/24"],
"snatIP": "12.2.3.4"
}
响应示例
{
"statusCode": 800,
"returnObj": [
{
"edgeID": "be012e8f-ea32-4a2c-89da-7db35eedb334",
"edgeName": "edge-001",
"dstEdgeName": "edge-002",
"dstEdgeID": "ae012e8f-ea32-4a2c-89da-7db35eedb334",
"status": 1
}
]
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
