华为云用户手册

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-route-policy:community-filter 是 REFERENCE 详细请参见表4。 团体属性过滤器配置参数。 -

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:community-filter/filter1 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-route-policy:community-filter" : { "name" : "filter1", "filter-type" : "basic", "basic-node" : [ { "sequence" : 1, "match-mode" : "permit", "community-member" : [ { "value" : "1:1" } ] } ] } }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:community-filter/{name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" name 是 string - - 名称，整数形式时范围1-99，字符串形式时1-51个字符且不能都是数字，单一主键字段。 "filter1"

请求示例 HTTP的示例 POST /restconf/data/huawei-nce-aoc-config-template-binding:template-binding/{template-binding-id} Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "template":[ { "template-id":"9534f559-d5f4-4534-a7ec-8cfce3f1337f" } ] }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-binding 是 REFERENCE 详细请参见表3。 list template binding. - 表3 template-binding-group-template-binding-infos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template-binding:template-binding 否 REFERENCE 详细请参见表4。 - -

响应示例 返回状态码为201：Created HTTP/1.1 201 Created Date: Fri,30 Dec 2022 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：Internal Error HTTP/1.1 400 Bad Request Date: Fri,30 Dec 2022 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /restconf/data/huawei-nce-aoc-config-template-binding:template-binding/{template-binding-id} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-binding-id 是 string 36个字节。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - the identifier of the template binding. "e5f97d04-7c18-41b7-a25a-702db1c108d7"

响应参数 返回状态码为200：查询成功。响应体参考GetRoleResponseDto。 表2 GetRoleResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageSize int32 - - 分页的大小。 20 pageIndex int32 - - 分页的序号。 1 totalRecords int32 - - 查询的总数。 2 roleList ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 角色详细信息。 - 表3 UserRoleDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 角色ID。UUID格式 "00000000-0000-0000-0000-000000000000" roleName string - - 角色名。 "name" description string - - 描述。 "20" 返回状态码为400：校验非法。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v2/accountservice/userrole/role?keyWord=roleName&sort=-name&pageSize=20&pageIndex=1 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：查询成功。响应体参考GetRoleResponseDto。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "pageSize" : 20, "pageIndex" : 1, "totalRecords" : 2, "roleList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "roleName" : "name", "description" : "20" } ] } 返回状态码为400：校验非法。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /controller/campus/v2/accountservice/userrole/role 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 keyWord 否 string - - 关键字，只支持模糊匹配角色名（roleName）。 "roleName" sort 否 string - - 排序，当前只支持根据name排序，+name代表按照角色名称升序，-name代表按照角色名称降序。 "-name" pageSize 否 int32 [1-1000] 20 分页的大小。 20 pageIndex 否 int32 [1-1000] 1 分页的序号。 1

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/wac/fbb684c8-0d37-496f-bafa-4b06d5151e2e/bind-fitaps 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 { "fitApInfoList" : [ { "deviceId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "esn" : "AP50082935AAAAAAAAA1", "mac" : "1324-4567-6789", "deviceModel" : "AP6050DN", "siteId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "status" : 0, "apId" : 1, "illegalStatus" : 1 } ], "siteApInfoList" : [ { "selectAll" : false, "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "apDeviceIdList" : [ "fbb684c8-0d37-406f-bafa-4b06d6151e2e" ], "unselectedApDeviceIdList" : [ "fbb684c8-0d37-406f-bafa-4b06d6151e2e" ] } ] }

响应示例 返回状态码为200：修改成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : [ { "deviceId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "esn" : "AP50082935AAAAAAAAA1", "mac" : "1324-4567-6789", "deviceModel" : "AP6050DN", "siteId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "status" : 0, "apId" : 1, "illegalStatus" : 1 } ] }

响应参数 返回状态码为200：修改成功。 表6 WACFitApResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-5000个列表项，详细请参见表4。 Fit AP设备信息的数据结构。 -

响应示例 返回状态码为201：创建成功，响应体参考DeviceManagerUserResponse。 HTTP/1.1 201 Created Date: Sun,16 Feb 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" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainId" : "00000000-0000-0000-0000-000000000000", "userName" : "name", "state" : "active", "serviceType" : "['http','ssh','terminal']", "privilegeLevel" : 0, "expireTime" : "2025-04-12T23:20:50.520Z", "timerange" : "10:00-12:00", "idleTimeout" : 5, "deviceUserId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1985-04-12 23:20:50" } } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/aaa/devicemanager 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 { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "domainId" : "00000000-0000-0000-0000-000000000000", "userName" : "name", "state" : "active", "serviceType" : "['http','ssh','terminal']", "privilegeLevel" : 0, "expireTime" : "2025-04-12T23:20:50.520Z", "timerange" : "10:00-12:00", "idleTimeout" : 5, "password" : "Example@123" }

响应参数 返回状态码为201：创建成功，响应体参考DeviceManagerUserResponse。 表3 DeviceManagerUserResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表4。 - - 表4 DeviceManagerUser对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID，UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" domainId uuid - - 域ID，UUID格式，需要先创建域。 "00000000-0000-0000-0000-000000000000" userName string 1~64个字符。 - 设备管理员名称。 创建后不允许修改。 其中V600版本设备的设备管理员名称有如下说明： a) 针对V600R021C00版本及之后版本的设备，名称为admin时补齐为administrator下发； b) 长度不能小于6； c) 不允许创建名称为administrator的设备管理员。 "name" state string active block active 帐号状态，该字段可以设置为以下几种： a) active：激活状态 b) block：阻塞状态 激活状态的帐号可以进行登录认证，阻塞状态的帐号设备拒绝登录认证。 默认值active。 "active" serviceType string - ['http'] 服务类型，该字段可以设置为以下几种： a) http b) ssh c) terminal http为不安全协议，建议使用更安全的服务类型。 默认值['http']。 "['http','ssh','terminal']" privilegeLevel integer [0-15] 0 用户级别，取值范围：0~15。 其中FW设备的用户级别取值范围为0~3。默认值0。 0 expireTime string 0~128个字符。满足正则表达((((20)(([2468][048])|([13579][26])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-9])))))|(((20)(([2468][1235679])|([13579][01345789])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-8]))))))T(([01][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])(\.\d{3})(Z|[\+\-]([0-5][0-9]):([0-5][0-9]))。 2099-12-31T00:00:00.000Z 帐号有效期截止时间，格式为YYYY-MM-DDTHH:MM:SS.SSSZ。 其中V600版本设备的帐号有效期截止时间最大可设置为2037-12-31T23:59:59.000Z。 默认2099-12-31T00:00:00.000Z，其中V600版本设备默认2037-12-31T23:59:59.000Z。 设备管理员创建后此属性不可修改。 "2025-04-12T23:20:50.520Z" timerange string 1~128个字符。满足正则表达^(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]-(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]$。 - 指定userName接入时间段范围，格式：HH:MM-HH:MM。 设备管理员创建后不可修改。 "10:00-12:00" idleTimeout int32 [0-1200] 10 用户的闲置超时时间，单位：秒。 默认为10。 5 deviceUserId uuid - - 设备管理员ID，UUID格式。 "00000000-0000-0000-0000-000000000000" createTime string 0~128个字符。 - 创建时间，UTC时间，格式：yyyy-MM-dd HH:mm:ss。 "1985-04-12 23:20:50" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceManager 是 REFERENCE 详细请参见表2。 设备管理员信息。 - 表2 DeviceManagerUserInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID，UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" domainId 是 uuid - - 域ID，UUID格式，需要先创建域。 "00000000-0000-0000-0000-000000000000" userName 是 string 1~64个字符。 - 设备管理员名称。 创建后不允许修改。 其中V600版本设备的设备管理员名称有如下说明： a) 针对V600R021C00版本及之后版本的设备，名称为admin时补齐为administrator下发； b) 长度不能小于6； c) 不允许创建名称为administrator的设备管理员。 "name" state 否 string active block active 帐号状态，该字段可以设置为以下几种： a) active：激活状态 b) block：阻塞状态 激活状态的帐号可以进行登录认证，阻塞状态的帐号设备拒绝登录认证。 默认值active。 "active" serviceType 否 string - ['http'] 服务类型，该字段可以设置为以下几种： a) http b) ssh c) terminal http为不安全协议，建议使用更安全的服务类型。 默认值['http']。 "['http','ssh','terminal']" privilegeLevel 否 integer [0-15] 0 用户级别，取值范围：0~15。 其中FW设备的用户级别取值范围为0~3。默认值0。 0 expireTime 否 string 0~128个字符。满足正则表达((((20)(([2468][048])|([13579][26])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-9])))))|(((20)(([2468][1235679])|([13579][01345789])))-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|(11))-(0[1-9]|[12][0-9]|(30)))|(((02)-(0[1-9]|[12][0-8]))))))T(([01][0-9])|(2[0-3])):([0-5][0-9]):([0-5][0-9])(\.\d{3})(Z|[\+\-]([0-5][0-9]):([0-5][0-9]))。 2099-12-31T00:00:00.000Z 帐号有效期截止时间，格式为YYYY-MM-DDTHH:MM:SS.SSSZ。 其中V600版本设备的帐号有效期截止时间最大可设置为2037-12-31T23:59:59.000Z。 默认2099-12-31T00:00:00.000Z，其中V600版本设备默认2037-12-31T23:59:59.000Z。 设备管理员创建后此属性不可修改。 "2025-04-12T23:20:50.520Z" timerange 否 string 1~128个字符。满足正则表达^(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]-(([01]?[0-9])|(2[0-3])):[0-5]?[0-9]$。 - 指定userName接入时间段范围，格式：HH:MM-HH:MM。 设备管理员创建后不可修改。 "10:00-12:00" idleTimeout 否 int32 [0-1200] 10 用户的闲置超时时间，单位：秒。 默认为10。 5 password 是 password 8~128个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 密码必须包含如下规则： 1.密码长度必须在8~128位。 2.密码必须满足复杂度，即至少包含英文大写字母(A~Z)、英文小写字母(a~z)、数字(0~9)、特殊字符(如!、@、#、$、%)等中的三种，V600版本的设备至少包含其中的四种，不允许包含'、?和空格。 3.密码中不能包含超过两个连续的相同字符。 4.密码不能为用户名或用户名的倒写。 "Example@123"

响应示例 返回状态码为200：查询成功。 { "errcode": "0", "errmsg": "", "data": { "deadInterval": 5, "deadCount": 2, "deadDetect": "by-server-ip" } } 返回状态码为400：操作失败信息。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "51384336", "errmsg" : "设备组Id格式错误或设备组不存在。", "errdesc" : "", "errreason" : "", "errdetail" : "", "erradvice" : "" } 返回状态码为500：内部服务错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：查询成功。 表2 RadiusDetectResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码：当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 Radius探测参数体 - 表3 RadiusDetectDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deadInterval int32 [1-300] - RADIUS服务器的探测周期。 5 deadCount int32 [1-65535] - 每个探测周期RADIUS服务器连续无响应的最大次数。 2 deadDetect string 0~24个字符。满足正则表达by-server-ip|by-authentication-server。 - 配置进行存活检测的服务器，by-server-ip代表对RADIUS认证服务器和计费服务器同时进行存活检测，by-authentication-server代表仅对RADIUS认证服务器进行存活检测 "by-server-ip" detectCycle int32 [1-5] 2 探测周期循环次数。 2 返回状态码为400：操作失败信息。 表4 FailResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "51384336" errmsg string 0~1000个字符。 - 错误信息。 "设备组Id格式错误或设备组不存在。" errdesc string 0~1000个字符。 - 错误描述。 - errreason string 0~1000个字符。 - 错误理由。 - errdetail string 0~1000个字符。 - 错误详细信息。 - erradvice string 0~1000个字符。 - 更正建议。 - 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/api/v1/networkconfig/radiusdetect/site/fbb684c8-0d37-496f-bafa-4b06d5151e2e 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

响应示例 返回状态码为204：成功 HTTP/1.1 204 No Content Date: Thu,21 Dec 2023 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：失败 HTTP/1.1 400 Bad Request Date: Thu,21 Dec 2023 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template:edit-temporary-template HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "huawei-nce-aoc-config-template:input": { "job-id": "5c261eb5-2f4a-4acc-a747-c77ee1d18083", "edit-template":[ { "template-name":"新增特性A", "content-type":"yaml", "template-content":"---\nhuawei-nce-e-vlan:vlan:\n- vlan-id: 1\n name: \"vlan1\"\n description: \"vlan1\"\n unknown-flow-drop: null\nhuawei-nce-e-snmp-user:snmp-user:\n agent-enable: true\n password-min-length: 10\n version: \"{snmp_user_version}\"" } ] } }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 edit-temporary-template 是 REFERENCE 详细请参见表2。 edit temporary template - 表2 edit-temporary-template-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:input REFERENCE 详细请参见表3。 - - 表3 edit-temporary-template-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 job-id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 任务ID "5c261eb5-2f4a-4acc-a747-c77ee1d18083" edit-template 是 ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 edit temporary input - 表4 edit-temporary-template-input-body-edit-template对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-name 是 string 1~128个字符。 - 模板名称 "test_template" content-type 是 string json yaml - 模板内容格式Json/Yaml "yaml" template-content 是 string 0~1048576个字符。 - 模板内容 "---\\nhuawei-nce-e-vlan:vlan:\\n- vlan-id: 1\\n name: \\\"vlan1\\\"\\n description: \\\"vlan1\\\"\\n unknown-flow-drop: null\\nhuawei-nce-e-snmp-user:snmp-user:\\n agent-enable: true\\n password-min-length: 10\\n version: \\\"{snmp_user_version}\\\""

响应示例 返回状态码为201：接口调用成功，响应体参考BridgeDomainResponse。 HTTP/1.1 201 Created Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为201：接口调用成功，响应体参考BridgeDomainResponse。 表5 BridgeDomainResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 创建或者更新成功的Bridge Domain信息。 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表8。 创建或者更新失败的Bridge Domain信息。 - 表6 BridgeDomainInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - Bridge Domain ID，主键，格式是uuid。创建时不填，自动生成，更新以及删除时必填。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID，格式是uuid。创建时必填。 "00000000-0000-0000-0000-000000000000" ports ARRAY_REFERENCE 0-64个列表项，详细请参见表7。 同一设备的二层端口信息列表，最大64个（包括增量和全量）。创建时必填。 - vlanId int32 [1-4094] - VLAN标识。创建时必填。网络编排资源中的属性cleanDefaultMngInterfaceConfig设置为true时，创建站点，创建TNP后，vlanId才可以指定为1。当VLAN被IpSubnet引用时，vlanId不允许修改。 2 description string 0~200个字符。 - Bridge Domain对应的描述。此功能仅用于展示，不下发配置到设备。 "description" configSource string 0~32个字符。 - 配置源信息，用于区分是WAN业务还是LanWan互联业务，仅查询接口使用，不能修改，取值范围：Wan、LanWan。 "Wan" 表7 BridgeDomainPortInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 接口ID，主键，格式是uuid，ID为必填参数。 "00000000-0000-0000-0000-000000000000" interfaceName string 0~128个字符。 - 接口名称，创建时不填，查询时返回。 "GE0/0/0" tagMode string 0~16个字符。 tag 取值范围：tag、untag。新建、修改时必填。对于同一个二层物理口，多个BridgeDomain只能有一个为untag。 "tag" portLagFlag boolean true false false Lag标志位。使能时ID为Lag的ID，反之为Port的ID。 false isAutoNegotiation boolean true false - VLAN放通的接口是否是自动创建。 false 表8 FailBridgeDomainInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表6。 - - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/overlay-network/bridge-domains 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 { "bridgeDomains" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } ], "fullReplace" : false }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bridgeDomainInfos 是 REFERENCE 详细请参见表2。 Bridge Domain的信息。 - 表2 BridgeDomainInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bridgeDomains 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 Bridge Domain信息。 - fullReplace 否 boolean true false false 开关为true时，表示全量更新。Bridge Domain以本次入参为准，不在本次入参范围内的将会被删除。开关为false时，表示增量更新，只对本次操作的数据生效。参数不传与false的效果一致。该开关对创建与删除无效，仅更新操作有效。 false 表3 BridgeDomainInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - Bridge Domain ID，主键，格式是uuid。创建时不填，自动生成，更新以及删除时必填。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID，格式是uuid。创建时必填。 "00000000-0000-0000-0000-000000000000" ports 否 ARRAY_REFERENCE 0-64个列表项，详细请参见表4。 同一设备的二层端口信息列表，最大64个（包括增量和全量）。创建时必填。 - vlanId 否 int32 [1-4094] - VLAN标识。创建时必填。网络编排资源中的属性cleanDefaultMngInterfaceConfig设置为true时，创建站点，创建TNP后，vlanId才可以指定为1。当VLAN被IpSubnet引用时，vlanId不允许修改。 2 description 否 string 0~200个字符。 - Bridge Domain对应的描述。此功能仅用于展示，不下发配置到设备。 "description" configSource 否 string 0~32个字符。 - 配置源信息，用于区分是WAN业务还是LanWan互联业务，仅查询接口使用，不能修改，取值范围：Wan、LanWan。 "Wan" 表4 BridgeDomainPortInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 uuid - - 接口ID，主键，格式是uuid，ID为必填参数。 "00000000-0000-0000-0000-000000000000" interfaceName 否 string 0~128个字符。 - 接口名称，创建时不填，查询时返回。 "GE0/0/0" tagMode 否 string 0~16个字符。 tag 取值范围：tag、untag。新建、修改时必填。对于同一个二层物理口，多个BridgeDomain只能有一个为untag。 "tag" portLagFlag 否 boolean true false false Lag标志位。使能时ID为Lag的ID，反之为Port的ID。 false isAutoNegotiation 否 boolean true false - VLAN放通的接口是否是自动创建。 false

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive