请求示例 HTTP的示例 PUT /controller/campus/v1/lanwan/vn/site-update HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] }

响应示例 返回状态码为200：修改成功返回。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为200：查询成功返回。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : [ { "name" : "vn1", "vpnInstanceName" : "vpn1", "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ], "ipsecEncryption" : true, "overlayHeadLength" : 36, "enableIPv6" : true, "description" : "vn", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：查询成功返回。 表2 QueryVnResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-300个列表项，详细请参见表3。 VN信息。 - 表3 VnInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 0~32个字符。 - VN名称。 "vn1" vpnInstanceName string 0~31个字符。 - 下发到设备的VPN实例名称，无需填充，查询返回。 "vpn1" siteInfos ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 站点ID列表，最大100个。 - ipsecEncryption boolean true false true 当链路未开启IPSEC加密功能时，可基于VPN配置是否开启IPSEC加密。 true overlayHeadLength int32 [1-512] - VPN隧道长度扣除字节数。当overlayHeadLength为null时，表示不配置overlayHeadLength 36 enableIPv6 boolean true false false 是否使能IPv6能力 true description string 0~200个字符。 - VN业务描述。 "vn" id string 0~36个字符。 - VN标识。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" 表4 SiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 36个字符。 - 站点标识，uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" siteName string 0~64个字符。 - 站点名称，不需要填充。 "site" isWanServiceNeeded boolean true false true 是否需要配置网关业务。站点中设备无网关角色时，isWanServiceNeeded置为false。站点有AR设备并且是网关角色并且站点已经开局时，如果需要配置网关设备业务，isWanServiceNeeded置为true。默认true。 true routeDistinguisher string 0~21个字符。 - 路由标识RD，填写后不支持修改。支持的格式如下：2字节自治系统号:4字节用户自定义数，其中自治系统号的取值范围是0～65535，用户自定义数的取值范围是0～4294967295，例如101:3。自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；整数形式4字节自治系统号:2字节用户自定义数，自治系统号的取值范围是65536～4294967295，用户自定义数的取值范围是0～65535，例如0:3或者65537:3。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；点分形式4字节自治系统号:2字节用户自定义数，点分形式自治系统号通常写成x.y的形式，x和y的取值范围都是0～65535，用户自定义数的取值范围是0～65535，例如0.0:3或者0.1:0。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0.0:0；IPv4地址:2字节用户自定义数，例如：192.168.122.15:1。IP地址的取值范围是0.0.0.0～255.255.255.255；用户自定义数的取值范围是0～65535。不可配置5500:5500因预留给增强模式下的vlanif使用。 "101:3" status string SUCCESS CONFIGURING FAIL - 下发状态，不需要填充。 "SUCCESS" errMsg string 0~256个字符。 - 错误信息，不需要填充。 "" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/lanwan/vn?vnId=a99f794e-b510-438c-a75d-de59f02347eb HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

响应参数 返回状态码为200：查询成功返回。 表2 QueryVnResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-300个列表项，详细请参见表4。 VN信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功返回。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : [ { "name" : "vn1", "vpnInstanceName" : "vpn1", "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ], "ipsecEncryption" : true, "overlayHeadLength" : 36, "enableIPv6" : true, "description" : "vn", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /controller/campus/v1/lanwan/vn?vnId=a99f794e-b510-438c-a75d-de59f02347eb HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

响应示例 返回状态码为200：添加成功返回。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] } } 返回状态码为202：请求正在处理中，请求处理详情请通过查询业务编排结果，确认是否处理成功。响应体参考VnSiteAsyncResponse。 HTTP/1.1 202 Accepted Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] }, "processInstanceId" : "" } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/lanwan/vn/site-attachment HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vnName" : "vn1", "asyncEnable" : true, "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ] }

响应参数 返回状态码为200：添加成功返回。 表4 VnSiteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 VN关联的站点信息。 - 表5 VnSiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vnId string 36个字符。 - VN标识，uuid格式。必填项。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vnName string 0~32个字符。 - VN名称，不需要填充。 "vn1" asyncEnable boolean true false - 是否开启异步下发。 true siteInfos ARRAY_REFERENCE 0-5000个列表项，详细请参见表5。 站点ID列表，单VN最多支持5000站点。每次最多变更100站点，比如修改时需要给VN新增和移除站点，单次操作新增和移除站点的数量之和需要小于100。 - 返回状态码为202：请求正在处理中，请求处理详情请通过查询业务编排结果，确认是否处理成功。响应体参考VnSiteAsyncResponse。 表6 VnSiteAsyncResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 VN关联的站点信息。 - processInstanceId string 0~36个字符。 - 编排流程实例ID，UUID格式。在接口返回码为202时设置。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnSiteInfo 是 REFERENCE 详细请参见表2。 VN信息。 - 表2 VnSiteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnId 是 string 36个字符。 - VN标识，uuid格式。必填项。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vnName 否 string 0~32个字符。 - VN名称，不需要填充。 "vn1" asyncEnable 否 boolean true false - 是否开启异步下发。 true siteInfos 否 ARRAY_REFERENCE 0-5000个列表项，详细请参见表3。 站点ID列表，单VN最多支持5000站点。每次最多变更100站点，比如修改时需要给VN新增和移除站点，单次操作新增和移除站点的数量之和需要小于100。 - 表3 SiteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点标识，uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" siteName 否 string 0~64个字符。 - 站点名称，不需要填充。 "site" isWanServiceNeeded 否 boolean true false true 该参数已经废弃，无需设置。 true routeDistinguisher 否 string 0~21个字符。 - 路由标识RD，填写后不支持修改。支持的格式如下：2字节自治系统号:4字节用户自定义数，其中自治系统号的取值范围是0～65535，用户自定义数的取值范围是0～4294967295，例如101:3。自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；整数形式4字节自治系统号:2字节用户自定义数，自治系统号的取值范围是65536～4294967295，用户自定义数的取值范围是0～65535，例如0:3或者65537:3。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；点分形式4字节自治系统号:2字节用户自定义数，点分形式自治系统号通常写成x.y的形式，x和y的取值范围都是0～65535，用户自定义数的取值范围是0～65535，例如0.0:3或者0.1:0。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0.0:0；IPv4地址:2字节用户自定义数，例如：192.168.122.15:1。IP地址的取值范围是0.0.0.0～255.255.255.255；用户自定义数的取值范围是0～65535。不可配置5500:5500因预留给增强模式下的vlanif使用。 "101:3" status 否 string SUCCESS CONFIGURING FAIL - 下发状态，不需要填充。 "SUCCESS" errMsg 否 string 0~256个字符。 - 错误信息，不需要填充。 ""

响应示例 返回状态码为200：OK HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100, "taskRecords" : 100, "sites" : [ { "id" : "b09a0266-f34e-125d-ce23-ad1278b6c59a", "name" : "site1", "isAddToVPN" : true, "isWanSite" : true, "isPnf" : true, "routeDistinguisher" : "101:3", "deviceGroupType" : ["AR","LSW"], "status" : "SUCCESS", "errMsg" : "" } ] } }

请求示例 HTTP的示例 POST /controller/campus/v1/lanwan/vn/members HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "vnId" : "b09a0266-f34e-125d-ce23-ad1278b6c59a", "siteId" : "b09a0266-f34e-125d-ce23-ad1278b6c59a", "pageIndex" : 1, "pageSize" : 20, "keyWord" : "site1", "type" : "BIND, UNBIND", "memberType" : "SITE", "taskType" : "TASK" }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 memberQueryInfo 是 REFERENCE 详细请参见表2。 查询条件 - 表2 VnMemberQueryParam对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnId 是 string 0~64个字符。 - 虚拟网络标识。 "b09a0266-f34e-125d-ce23-ad1278b6c59a" siteId 否 string 36个字符。 - 站点ID。 "b09a0266-f34e-125d-ce23-ad1278b6c59a" pageIndex 否 int32 [1-10000] - 分页索引。 1 pageSize 否 int32 [1-100] - 分页大小。 20 keyWord 否 string 0~64个字符。 - 关键字。 "site1" type 否 string 0~64个字符。 - 指定查询类型，当为BIND时，为虚拟网络已经关联成员，当为UNBIND时，为虚拟网络可以添加的成员，缺省情况下，按照UNBIND查询。 "BIND, UNBIND" memberType 否 string SITE - 指定成员类型，当前该字段没有意义，不需要传值。 "SITE" taskType 否 string MEMBER TASK - 需要查询的任务类型，当前支持 MEMBER（已经加入VN的成员），TASK（正在处理的任务） "TASK"