华为云用户手册

响应示例 返回状态码为201：创建TNP成功，响应体参考TnpResponse。 HTTP/1.1 201 Created 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" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "Link1", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "portId" : "00000000-0000-0000-0000-000000000000", "portType" : 1, "portNum" : "0/0/1", "enable5G" : "", "inSubInterface" : false, "vlanId" : 1, "subInterfaceNumber" : 1, "tnplinkInfo" : { "cellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "standbyCellularEnable" : false, "standbyCellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "simSwitchBackEnable" : false, "simSwitchBackTime" : 60, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 } }, "ipConnection" : { "ipv4" : { "publicIP" : "192.168.1.1", "accessType" : "PPPoE", "ipMode" : "Static", "customerAddress" : "192.168.1.1", "prefixLength" : 24, "providerAddress" : "192.168.1.1", "peerIp" : "192.168.1.1", "userName" : "admin", "userKey" : "******", "authType" : 0, "dlci" : 55, "interfaceMode" : 0 }, "ipv6" : { "accessType" : "IPoE", "ipMode" : "Static", "customerIPv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "providerIpv6Address" : "fc00:3::1", "linkIpv6Pd" : "sdwanprefix", "linkIpv6PdAddr" : "fc00:3::1/64", "linkDhcpv6Option16Type" : "ascii", "linkDhcpv6Option16" : "101068,0001", "linkDhcpv6Pd" : "sdwanprefix", "enableIPv6AcSouthAccess" : true, "ipv6AcSouthAccessId" : "00000000-0000-0000-0000-000000000003", "ipv6MailUsedSouthAccess" : false, "ipv6AccessPreference" : "low" } }, "transportNetworkInfo" : { "transportNetworkId" : "00000000-0000-0000-0000-000000000000", "workMode" : "active", "sendAlarmEnabled" : false }, "ntp" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 10 } ], "attributes" : { "inputBandwidth" : 1000, "outputBandwidth" : 1000, "mtu" : 1500, "TCPmss" : 1200, "ipv6Mtu" : 1500 }, "description" : "site tnp", "natEnable" : false, "ztpMode" : 0, "ipv6ZtpMode" : 0, "underlayVrf" : "underlay_1", "routingDistinguisher" : "1111:1111", "clearDeviceConfig" : true, "enableOverlay" : true, "enableIpv6Overlay" : false, "acSouthAccessId" : "00000000-0000-0000-0000-000000000001", "mailUsedSouthAccess" : false, "linkInformation" : "link1", "accessPreference" : "low", "enableSecondSouthAccess" : false, "secondSouthAccess" : { "acSouthAccessId" : "00000000-0000-0000-0000-000000000002", "accessPreference" : "low" }, "syncModifyDeviceUrlConfig" : false, "enableLoopbackSrcInterface" : false, "enableRu" : false, "disableDefaultRuRoute" : false } ], "fail" : [ { "errcode" : "error", "errmsg" : "error message", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "Link1", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "portId" : "00000000-0000-0000-0000-000000000000", "portType" : 1, "portNum" : "0/0/1", "enable5G" : "", "inSubInterface" : false, "vlanId" : 1, "subInterfaceNumber" : 1, "tnplinkInfo" : { "cellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "standbyCellularEnable" : false, "standbyCellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "simSwitchBackEnable" : false, "simSwitchBackTime" : 60, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 } }, "ipConnection" : { "ipv4" : { "publicIP" : "192.168.1.1", "accessType" : "PPPoE", "ipMode" : "Static", "customerAddress" : "192.168.1.1", "prefixLength" : 24, "providerAddress" : "192.168.1.1", "peerIp" : "192.168.1.1", "userName" : "admin", "userKey" : "******", "authType" : 0, "dlci" : 55, "interfaceMode" : 0 }, "ipv6" : { "accessType" : "IPoE", "ipMode" : "Static", "customerIPv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "providerIpv6Address" : "fc00:3::1", "linkIpv6Pd" : "sdwanprefix", "linkIpv6PdAddr" : "fc00:3::1/64", "linkDhcpv6Option16Type" : "ascii", "linkDhcpv6Option16" : "101068,0001", "linkDhcpv6Pd" : "sdwanprefix", "enableIPv6AcSouthAccess" : true, "ipv6AcSouthAccessId" : "00000000-0000-0000-0000-000000000003", "ipv6MailUsedSouthAccess" : false, "ipv6AccessPreference" : "low" } }, "transportNetworkInfo" : { "transportNetworkId" : "00000000-0000-0000-0000-000000000000", "workMode" : "active", "sendAlarmEnabled" : false }, "ntp" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 10 } ], "attributes" : { "inputBandwidth" : 1000, "outputBandwidth" : 1000, "mtu" : 1500, "TCPmss" : 1200, "ipv6Mtu" : 1500 }, "description" : "site tnp", "natEnable" : false, "ztpMode" : 0, "ipv6ZtpMode" : 0, "underlayVrf" : "underlay_1", "routingDistinguisher" : "1111:1111", "clearDeviceConfig" : true, "enableOverlay" : true, "enableIpv6Overlay" : false, "acSouthAccessId" : "00000000-0000-0000-0000-000000000001", "mailUsedSouthAccess" : false, "linkInformation" : "link1", "accessPreference" : "low", "enableSecondSouthAccess" : false, "secondSouthAccess" : { "acSouthAccessId" : "00000000-0000-0000-0000-000000000002", "accessPreference" : "low" }, "syncModifyDeviceUrlConfig" : false, "enableLoopbackSrcInterface" : false, "enableRu" : false, "disableDefaultRuRoute" : false } } ] } 返回状态码为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/sdwan/netstream/global/00000000-0000-0000-0000-000000000000 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

响应示例 返回状态码为200：配置成功，响应体参考NetstreamResponse。 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" : { "config-status" : "", "errorInfo" : "", "flowInsts" : { "flowInst" : [ { "flowType" : "IPv4", "sourceIpv4Address" : "192.168.1.1", "sourceIpv4Port" : 2000, "exportVersion" : 5, "indexSwitch" : 32, "tcpSessionTimeout" : false, "preClassify" : false, "sysMacEnable" : false, "originActiveAgeSeconds" : 1800, "originInactiveSeconds" : 15, "templateTimeoutRate" : 1, "exportIpV4Hosts" : [ { "address" : "192.168.2.1", "port" : 2000, "vpnName" : "underlay_1", "dscpValue" : 15 } ] } ] }, "flexFlowRecords" : { "flexFlowRecord" : [ { "flowType" : "IPv4", "recordName" : "record1", "protocol" : true, "tos" : true, "sourceAddress" : true, "destinationAddress" : true, "sourcePort" : true, "destinationPort" : true, "bytesValue" : true, "packetsValue" : false, "inputInterface" : false, "outputInterface" : false, "sdWanConnection" : false, "applicationName" : false, "sysMacEnable" : false } ] }, "tmAfterEnable" : false, "sourceIdExtendEnable" : false } } 返回状态码为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：查询成功，响应体参考AuthenticationLogOutputDto。 表2 AuthenticationLogOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 startRowKey string 0~256个字符。 - 查询结果中起始rowkey值。 "1529648614575D431E4891D734D68B89FD14BAC639C47" endRowKey string 0~256个字符。 - 查询结果中结束rowkey值。 "15296432844906C2BC8D50ED94D9A87C4660E418E6472" totalRecords int32 [0-101] - 本次查询到的总结果数。最大取值为101，不足101条时表示当前数据已查询完；等于101条表示后续还有数据。 "101" errcode string 0~32个字符。 - 错误码。0表示没有错误。 "0" errmsg string 0~512个字符。 - 错误信息描述。 "" searchResultList ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 查询结果列表。 - 表3 AuthenticationLogDetailOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 rowKey string 0~256个字符。 - 数据主键rowkey。 "1529648614575D431E4891D734D68B89FD14BAC639C47" accessDeviceGroupName string 0~128个字符。 - 站点名称。 "Suzhou RnD Center" authResult string 0~10个字符。 - 认证结果。取值范围：（0---成功 1---失败） "1" onlineTime string 0~32个字符。 - 用户上线起始时间（接口调用方格林威治时间戳），单位：毫秒。 "1529648614575" offlineTime string 0~32个字符。 - 用户上线的结束时间（接口调用方格林威治时间戳），单位：毫秒。 "1529648764461" account string 0~255个字符。 - 用户名。 "anonymous" terminalIP string 0~32个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 终端IP地址。 "192.168.216.247" userGroup string 0~1024个字符。 - 终端用户所属用户组。 "ROOT" terminalMac string 0~32个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 终端MAC地址，mac格式：XX-XX-XX-XX-XX-XX。 "XX-XX-XX-XX-XX-XX" authType string 0~10个字符。 - 认证方式。取值范围：（1---Portal HACA认证 2---MAC免认证 3---第三方认证 4---PPSK认证 11---Portal2.0/CMCC 认证 16---CWA 认证）。 "1" userType string 0~10个字符。 - 用户类型。取值范围：(0---普通用户 1---短信注册用户 2---自注册用户 4---社交媒体用户 5---微信用户 6---Passcode用户 7---第三方用户 10---AD用户 11---PPSK用户 12---RADIUS Token用户 13---LDAP用户 14---SAML认证用户 20---普通访客 21---MAC帐号 22---第三方HTTP用户 23---未知用户 24---公共二维码用户 27---第三方数据库用户 64---匿名用户)。 "4" authServerIP string 0~32个字符。 - 认证服务器IP地址。 "192.168.254.206" accessSSID string 0~64个字符。 - 接入SSID。 "CloudCampus_Guest" deviceMac string 0~32个字符。 - 接入设备MAC地址，mac格式：XX-XX-XX-XX-XX-XX。 "XX-XX-XX-XX-XX-XX" deviceIP string 0~32个字符。 - 接入设备IP。 "10.1.1.1" accessPolicy string 0~64个字符。 - 接入授权策略。 "CloudCampus_Guest" authenRule string 0~64个字符。 - 认证规则。 "Default" name string 0~64个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 姓名 "" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考AuthenticationLogOutputDto。 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 { "startRowKey" : "1529648614575D431E4891D734D68B89FD14BAC639C47", "endRowKey" : "15296432844906C2BC8D50ED94D9A87C4660E418E6472", "totalRecords" : "101", "errcode" : "0", "errmsg" : "", "searchResultList" : [ { "rowKey" : "1529648614575D431E4891D734D68B89FD14BAC639C47", "accessDeviceGroupName" : "Suzhou RnD Center", "authResult" : "1", "onlineTime" : "1529648614575", "offlineTime" : "1529648764461", "account" : "anonymous", "terminalIP" : "192.168.216.247", "userGroup" : "ROOT", "terminalMac" : "XX-XX-XX-XX-XX-XX", "authType" : "1", "userType" : "4", "authServerIP" : "192.168.254.206", "accessSSID" : "CloudCampus_Guest", "deviceMac" : "XX-XX-XX-XX-XX-XX", "deviceIP" : "10.1.1.1", "accessPolicy" : "CloudCampus_Guest", "authenRule" : "Default", "name" : "" } ] } 返回状态码为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/accountservice/user/authenticationlog?startRowKey=1529648625738B5F4EF82E97A4BD69FFF258082996290&siteId=a91e1696-02a2-4a68-bad4-aa639359c8cf&authResult=1&lowerOnlineTime=1529510400000&upperOnlineTime=1529683199000&lowerOfflineTime=1529510400000&upperOfflineTime=1529683199000&userName=zhangsan&name=zhangsan1&terminalMac=XX-XX-XX-XX-XX-XX&userType=1&accessSSID=guest&branchId=87202e72-0088-4892-87f5-74082f248f79&queryMode=ONE_SITE 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

URI /controller/campus/v1/accountservice/user/authenticationlog 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 startRowKey 是 string - - 起始rowkey（首次查询为空字符串，分页查询时取上一次查询结果endRowKey的值）。 "1529648625738B5F4EF82E97A4BD69FFF258082996290" siteId 否 UUID - - 站点ID，格式为UUID，当queryMode为单站点查询模式，站点ID必填。 "a91e1696-02a2-4a68-bad4-aa639359c8cf" authResult 是 string - - 认证结果。取值范围：（0---成功，1---失败）。 "1" lowerOnlineTime 否 int64 [0-9999999999999] - 用户上线起始时间（接口调用方格林威治时间戳），单位：毫秒。私有云场景为必填 1529510400000 upperOnlineTime 否 int64 [0-9999999999999] - 用户上线的结束时间（接口调用方格林威治时间戳），单位：毫秒。私有云场景为必填，查询时不允许查询时间跨度大于7天的数据。 1529683199000 lowerOfflineTime 否 int64 [0-9999999999999] - 用户下线起始时间（接口调用方格林威治时间戳），单位：毫秒。 1529510400000 upperOfflineTime 否 int64 [0-9999999999999] - 用户下线的结束时间（接口调用方格林威治时间戳），单位：毫秒。查询时不允许查询时间跨度大于7天的数据。 1529683199000 userName 否 string 0~128个字符。 - 用户名（短信认证则为手机号码）。 "zhangsan" name 否 string 0~128个字符。 - 姓名。 "zhangsan1" terminalMac 否 string 0~32个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 接入终端MAC地址（格式：XX-XX-XX-XX-XX-XX）。 "XX-XX-XX-XX-XX-XX" userType 否 string - - 用户类型。取值范围：(0---普通用户 1---短信注册用户 2---自注册用户 4---社交媒体用户 5---微信用户 6---Passcode用户 7---第三方用户 10---AD用户 11---PPSK用户 12---RADIUS Token用户 13---LDAP用户 14---SAML认证用户 20---普通访客 21---MAC帐号 22---第三方HTTP用户 23---未知用户 24---公共二维码用户 27---第三方数据库用户 64---匿名用户)。 "1" accessSSID 否 string 0~64个字符。 - 接入SSID名称。 "guest" branchId 否 string 0~64个字符。 - 远程IAE组件ID。UUID格式 "87202e72-0088-4892-87f5-74082f248f79" queryMode 否 string ONE_SITE NOT_IN_SITE ONE_SITE 查询模式：ONE_SITE--单站点，NOT_IN_SITE--未加入站点 "ONE_SITE"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:ext-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-199，字符串形式时1-51个字符且不能都是数字，单一主键字段。 "filter1"

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

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:ext-community-filter/filter1 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-route-policy:ext-community-filter" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "filter1", "filter-type" : "basic", "basic-node" : [ { "sequence" : 1, "match-mode" : "permit", "ext-community-member" : [ { "value" : "1:1" } ] } ] } ] }

响应示例 返回状态码为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 返回状态码为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

响应示例 返回状态码为201：操作成功。 HTTP/1.1 201 Created 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 { "name" : "group1", "description" : "this is template group1", "id" : "00000000-0000-0000-0000-000000000000", "type" : "preset", "bindingSiteNum" : "", "createTime" : "1713880927744", "updateTime" : "1713880927744" } 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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

响应参数 返回状态码为201：操作成功。 表3 TemplateGroupResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~128个字符。 - 名称。 "group1" description string 0~1024个字符。 - 描述。 "this is template group1" id string 36个字符。 - 模板组ID，UUID格式。 "00000000-0000-0000-0000-000000000000" type string 1~10个字符。满足正则表达preset|customize。 - 模板组类型。preset：预置，customize：自定义 "preset" bindingSiteNum int32 [0-1000] 0 绑定站点数。 - createTime int64 [1577808000000-4733481600000] - 时间戳。 "1713880927744" updateTime int64 [1577808000000-4733481600000] - 时间戳。 "1713880927744" 返回状态码为400：校验异常。 表4 CommonDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~64个字符。 0 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templateGroup 是 REFERENCE 详细请参见表2。 模板组创建入参。 - 表2 TemplateGroup对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~128个字符。 - 名称。 "group1" description 否 string 0~1024个字符。 - 描述。 "this is template group1"

请求示例 HTTP的示例 POST /v1/networkservice/hierarchy-template/template-groups 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 { "name" : "group1", "description" : "this is template group1" }

响应示例 返回状态码为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 返回状态码为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

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:route-policy/{name}/nodes 表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~200个字符。 - 名称，单一主键字段。 "policy1"

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:route-policy/policy1/nodes 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

响应示例 返回状态码为200：查询成功，响应体参考RadioCountryChannelResult。 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 { "pageIndex" : "", "pageSize" : "", "totalRecords" : "", "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "9393e1a6-f9b0-45ae-a454-ea40e73b1339", "countryCode" : "CN", "countryNameKey" : "naas.networksvcmgr.wlan.country.China", "countryName" : "China", "channel2dot4" : "1-13", "channel5HT20Indoor" : "36,40,44,48,52,56,60,64,149,153,157,161,165", "channel5HT20Outdoor" : "149,153,157,161,165", "channel5HT40PlusIndoor" : "36,44,52,60,149,157", "channel5HT40PlusOutdoor" : "149,157", "channel5HT40MinusIndoor" : "40,48,56,64,153,161", "channel5HT40MinusOutdoor" : "153,161", "channel5HT80Indoor" : "36,40,44,48,52,56,60,64,149,153,157,161", "channel5HT80Outdoor" : "149,153,157,161", "channel5HT160Indoor" : "36,40,44,48,52,56,60,64,149,153,157,161", "channel5HT160Outdoor" : "149,153,157,161", "Channel6HT20Indoor" : "149,153,157,161", "Channel6HT20Outdoor" : "149,153,157,161", "Channel6HT40PlusIndoor" : "149,153,157,161", "Channel6HT40PlusOutdoor" : "149,153,157,161", "Channel6HT40MinusIndoor" : "149,153,157,161", "Channel6HT40MinusOutdoor" : "149,153,157,161", "Channel6HT80Indoor" : "149,153,157,161", "Channel6HT80Outdoor" : "149,153,157,161", "Channel6HT160Indoor" : "149,153,157,161", "Channel6HT160Outdoor" : "149,153,157,161", "Channel6HT320Indoor" : "149,153,157,161", "Channel6HT320Outdoor" : "149,153,157,161" } ] }

响应参数 返回状态码为200：查询成功，响应体参考RadioCountryChannelResult。 表1 RadioCountryChannelResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex integer - - 当前字段不支持，返回null。 - pageSize integer [0-100] - 当前字段不支持，返回null。 - totalRecords integer - - 当前字段不支持，返回null。 - errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 详细请参见表2。 国家码信息。 - 表2 RadioCountryChannelDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 国家码ID。 "9393e1a6-f9b0-45ae-a454-ea40e73b1339" countryCode string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 国家码。 "CN" countryNameKey string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 国家名称国际化key。 "naas.networksvcmgr.wlan.country.China" countryName string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 国家名称。 "China" channel2dot4 string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 支持的2.4G信道。 "1-13" channel5HT20Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT20下支持的室内5G信道。 "36,40,44,48,52,56,60,64,149,153,157,161,165" channel5HT20Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT20下支持的室外5G信道。 "149,153,157,161,165" channel5HT40PlusIndoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40+下支持的室内5G信道。 "36,44,52,60,149,157" channel5HT40PlusOutdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40+下支持的室外5G信道。 "149,157" channel5HT40MinusIndoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40-下支持的室内5G信道。 "40,48,56,64,153,161" channel5HT40MinusOutdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40-下支持的室外5G信道。 "153,161" channel5HT80Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT80下支持的室内5G信道。 "36,40,44,48,52,56,60,64,149,153,157,161" channel5HT80Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT80下支持的室外5G信道。 "149,153,157,161" channel5HT160Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT160下支持的室内5G信道。 "36,40,44,48,52,56,60,64,149,153,157,161" channel5HT160Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT160下支持的室外5G信道。 "149,153,157,161" Channel6HT20Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT20下支持的室内6G信道。 "149,153,157,161" Channel6HT20Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT20下支持的室外6G信道。 "149,153,157,161" Channel6HT40PlusIndoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40+下支持的室内6G信道。 "149,153,157,161" Channel6HT40PlusOutdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40+下支持的室外6G信道。 "149,153,157,161" Channel6HT40MinusIndoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40-下支持的室内6G信道。 "149,153,157,161" Channel6HT40MinusOutdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT40-下支持的室外6G信道。 "149,153,157,161" Channel6HT80Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT80下支持的室内6G信道。 "149,153,157,161" Channel6HT80Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT80下支持的室外6G信道。 "149,153,157,161" Channel6HT160Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT160下支持的室内6G信道。 "149,153,157,161" Channel6HT160Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT160下支持的室外6G信道。 "149,153,157,161" Channel6HT320Indoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT320下支持的室外6G信道。 "149,153,157,161" Channel6HT320Outdoor string - - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 HT320下支持的室外6G信道。 "149,153,157,161"

请求示例 HTTP的示例 GET /controller/campus/v3/configresource/channels 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

请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/vpn 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 { "vpnId" : "310473a6-8006-48a3-9558-543d32ea1757", "templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" }

响应示例 返回状态码为201：接口调用成功，响应体参考OverlayWanBgpPolicyTemplateBindSiteResponse。 HTTP/1.1 201 Created 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" : "00000000-0000-0000-0000-000000000000" } 返回状态码为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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 overlayWanBgpPolicyTemplateSite 是 REFERENCE 详细请参见表2。 Overlay WAN侧BGP路由信息。 - 表2 OverlayWanBgpPolicyTempBindVpnRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 string - - VPN ID。UUID格式 "310473a6-8006-48a3-9558-543d32ea1757" templateId 是 string - - 模板ID。UUID格式 "fbb684c8-0d37-496f-bafa-4b06d515j7l6"

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology/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 { "areas" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "area_1", "areaType" : "leaf", "topologyType" : "hub-spoke", "enableDynamicTunnel" : "", "gatewayIPv6Enable" : false, "hubWorkMode" : "with-interconnection", "isFullReplaceSite" : "", "siteAttachments" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "siteRoles" : [{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}], "accessServiceHubs" : [ { "siteName" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "accessPriority" : 2 } ], "borderRelationShip" : { "activeBorderSiteId" : "00000000-0000-0000-0000-000000000000", "activeBorderSiteName" : "Site Name", "standbyBorderSiteId" : "00000000-0000-0000-0000-000000000000", "standbyBorderSiteName" : "Site Name" }, "enableHubLanConnect" : "" } ] } ] }

响应参数 返回状态码为200：拓扑中增加站点成功，响应体参考TopologyResponse。 TopologyResponse对象的参数列表，详细请参见表9。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考TopologyResponse。 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：拓扑中增加站点成功，响应体参考TopologyResponse。 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" : "", "topology" : { "areas" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "area_1", "areaType" : "leaf", "topologyType" : "hub-spoke", "enableDynamicTunnel" : "", "gatewayIPv6Enable" : false, "hubWorkMode" : "with-interconnection", "isFullReplaceSite" : "", "siteAttachments" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "siteRoles" : [{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}], "accessServiceHubs" : [ { "siteName" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "accessPriority" : 2 } ], "borderRelationShip" : { "activeBorderSiteId" : "00000000-0000-0000-0000-000000000000", "activeBorderSiteName" : "Site Name", "standbyBorderSiteId" : "00000000-0000-0000-0000-000000000000", "standbyBorderSiteName" : "Site Name" }, "enableHubLanConnect" : "" } ] } ] }, "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考TopologyResponse。 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 返回状态码为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/sdwan/policy/traffic/bandwidth-management-policies?sort=policyName&policyId=00000000-0000-0000-0000-00000000000&vpnId=00000000-0000-0000-0000-000000000000&vpnGroupId=00000000-0000-0000-0000-000000000000&policyName=policy&siteId=00000000-0000-0000-0000-000000000000 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：查询成功，响应体参考QueryBandwidthMgrPolicyResponse。 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" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ] } 返回状态码为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

URI /controller/campus/v1/sdwan/policy/traffic/bandwidth-management-policies 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-65535] 1 当前页数。 - pageSize 否 int32 [1-1000] 20 总页数，默认是20。 - sort 否 string 0~255个字符。 - 排序字段。 当前仅支持按policyName排序，"policyName"表示升序，"-policyName"表示降序，默认升序。 "policyName" policyId 否 string 0~64个字符。 - 策略ID。 "00000000-0000-0000-0000-00000000000" vpnId 否 string 0~64个字符。 - VPN业务ID。vpnId和vpnGroupId最多只能配置其中一个进行查询。 "00000000-0000-0000-0000-000000000000" vpnGroupId 否 string 0~64个字符。 - Qos VPN Group业务ID。vpnId和vpnGroupId最多只能配置其中一个进行查询。 "00000000-0000-0000-0000-000000000000" policyName 否 string 0~64个字符。 - 策略名称，支持模糊匹配。 "policy" siteId 否 string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000"