华为云用户手册

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 tacacs服务器模板body。 - 表3 updateTacacsTmplInfoDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~32个字符。 - 名称（不支持$&?=+%][^_,#"相关特殊字符, 不支持修改）。 "tacacs1" description 否 string 0~128个字符。 - 描述。 "" masterAuthenServerIp 是 string - - 主认证服务器IP地址。 "10.0.0.10" masterAuthenServerPort 是 integer [1-65535] - 主认证服务器端口。 20 slaveAuthenServerIp 否 string - - 备认证服务器IP地址。 "10.1.1.10" slaveAuthenServerPort 否 integer [1-65535] - 备认证服务器端口。 20 thirdAuthenServerIp 否 string 0~15个字符。 - 第三认证服务器IP地址。 "10.0.0.10" thirdAuthenServerPort 否 int32 [1-65535] - 第三认证服务器端口。 20 masterAuthorServerIp 否 string - - 主授权服务器IP地址。 "10.0.0.10" masterAuthorServerPort 否 integer [1-65535] - 主授权服务器端口。 30 slaveAuthorServerIp 否 string - - 备授权服务器IP地址。 "10.1.1.10" slaveAuthorServerPort 否 integer [1-65535] - 备授权服务器端口。 30 thirdAuthorServerIp 否 string 0~15个字符。 - 第三授权服务器IP地址。 "10.0.0.10" thirdAuthorServerPort 否 int32 [1-65535] - 第三授权服务器端口。 30 masterAccServerIp 否 string - - 主计费服务器IP地址。 "10.0.0.10" masterAccServerPort 否 integer [1-65535] - 主计费服务器端口。 40 slaveAccServerIp 否 string - - 备计费服务器IP地址。 "10.1.1.10" slaveAccServerPort 否 integer [1-65535] - 备计费服务器端口。 40 thirdAccServerIp 否 string 0~15个字符。 - 主计费服务器IP地址。 "10.0.0.10" thirdAccServerPort 否 int32 [1-65535] - 主计费服务器端口。 40 includeDomain 否 boolean true false true 向Tacacs服务器发起认证的用户名是否包含 域名 。默认值为true。 false builtInServerEnable 否 boolean true false false 是否启用内置服务器。目前还不支持，只用来做查询接口返回值，默认值为false。 false sourceIpEnable 否 boolean true false - 源IP配置使能 true configName 否 string 0~20个字符。满足正则表达^[a-zA-Z0-9._-]{0,20}$。 - 配置名称标识，用于tacacs-server-name "abc" shareKey 否 password 1~255个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 秘钥（英文字母、数字、除空格和问号外特殊符号，建议长度不小于8位），秘钥不能全为“*”。 "null"

响应示例 返回状态码为200：批量查询南向接入服务成功，响应体参考SouthAccessQueryOutput。 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" : "OK", "totalRecords" : 1, "data" : [ { "id" : "00000000-0000-0000-000000000000", "name" : "运营商A", "description" : "运营商A的南向ip", "enable" : "false", "mainIp" : "192.168.10.10", "backupIp" : "192.168.10.11", "ipType" : "IPv4", "priority" : 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

响应参数 返回状态码为200：批量查询南向接入服务成功，响应体参考SouthAccessQueryOutput。 表1 SouthAccessQueryOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~64个字符。 - 错误码 "0" errmsg string 1~2048个字符。 - 错误信息 "OK" totalRecords int32 [1-8] - 总计条数 1 data ARRAY_REFERENCE 0-4个列表项，详细请参见表4。 南向接入服务列表 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误 详细信息请参见实际响应消息体。

响应参数 返回状态码为200：查询成功，响应体参考GetMacTableOutputDto。 表4 GetMacTableOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码： 当没有错误时返回0 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "查询失败" table ARRAY_REFERENCE 0-200个列表项，详细请参见表5。 MAC表项结果。 - nextPage boolean true false - 是否有下一页 "true" totalCount integer - - MAC表项信息总数。 10 表5 MacTableDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 macAddr string - - mac地址。格式：XX-XX-XX-XX-XX-XX。 "xx-xx-xx-xx-xx-xx" idType string - - 转发域类型。取值范围：bd（查询bd类型转发域的mac），vlan（查询vlan类型转发域的mac），vsi（查询bd类型转发域的mac）。 "vlan" id string - - 转发域的vlan值。 "1" macType string - - mac类型。取值范围：dynamic（动态），sticky（），security（安全）。 "dynamic" forwardingInterface string - - 接口号。 "XGigabitEthernet0/0/1" 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考GetMacTableOutputDto。 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" : "查询失败", "table" : [ { "macAddr" : "xx-xx-xx-xx-xx-xx", "idType" : "vlan", "id" : "1", "macType" : "dynamic", "forwardingInterface" : "XGigabitEthernet0/0/1" } ], "nextPage" : "true", "totalCount" : 10 } 返回状态码为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/oamservice/mactable/{deviceId}/{rType} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" rType 是 string - - 分页参数。first代表第一页，next代表下一页。使用next需要在additionalInfo填入当前页的最后一条mac信息。 "first"

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 additionalInfo 是 REFERENCE 详细请参见表3。 请求参数 - 表3 MacInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 searchType 是 string - - 查询类型，该字段可以设置为以下几种： a) all：全部查询 b) interface：按端口查询 c) vlan：按转发域查询 d) mac：按mac地址查询 "all" macAddr 否 string - - mac地址，格式仅支持XX-XX-XX-XX-XX-XX。 当searchType字段是mac时，必须设置该字段。 "xx-xx-xx-xx-xx-xx" idType 否 string - - 转发域类型。 当searchType字段是vlan时，必须设置该字段，该字段可以设置为以下几种： a) bd：查询bd类型转发域的mac b) vlan：查询bd类型转发域的mac c) vsi：查询vsi类型转发域的mac "vlan" id 否 string - - 转发域的vlan值。 当searchType字段是vlan时，必须设置该字段。 "1" interfaceId 否 string - - 端口号。 当searchType字段是interface时，必须设置该字段。 "XGigabitEthernet0/0/1" num 否 integer [10-200] 10 单次查询数量。默认值为10。 10

请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/mactable/00000000-0000-0000-0000-000000000000/first 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-yyyy { "searchType" : "all", "macAddr" : "", "idType" : "", "id" : "", "interfaceId" : "", "num" : 10 }

响应示例 返回状态码为200：配置成功，响应体参考SnmpUserResponse。 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" : "reserved", "errorInfo" : "", "agentEnable" : true, "allIpv4Interface" : false, "passwordMinLength" : 8, "usmUserCmplxCheck" : false, "sysContact" : "R&D Beijing, Huawei Technologies co.,Ltd.", "sysLocation" : "Beijing China", "mibViews" : { "mibView" : [ { "viewName" : "view1", "whiteList" : [ "iso" ], "blackList" : [ "internet" ] } ] }, "v3Groups" : { "group" : [ { "groupName" : "group", "securityLevel" : "privacy", "acl" : 2000, "readView" : "view1", "writeView" : "view1", "notifyView" : "view1" } ] }, "usmUsers" : { "usmUser" : [ { "name" : "user", "groupName" : "group", "authProtocol" : "sha2-512", "authKey" : "Example@123", "privProtocol" : "aes256", "privKey" : "Example@234" } ] } } } 返回状态码为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的示例 POST /controller/campus/v1/sdwan/snmp/user/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 { "config-status" : "reserved", "errorInfo" : "", "agentEnable" : true, "allIpv4Interface" : false, "passwordMinLength" : 8, "usmUserCmplxCheck" : false, "sysContact" : "R&D Beijing, Huawei Technologies co.,Ltd.", "sysLocation" : "Beijing China", "mibViews" : { "mibView" : [ { "viewName" : "view1", "whiteList" : [ "iso" ], "blackList" : [ "internet" ] } ] }, "v3Groups" : { "group" : [ { "groupName" : "group", "securityLevel" : "privacy", "acl" : 2000, "readView" : "view1", "writeView" : "view1", "notifyView" : "view1" } ] }, "usmUsers" : { "usmUser" : [ { "name" : "user", "groupName" : "group", "authProtocol" : "sha2-512", "authKey" : "Example@123", "privProtocol" : "aes256", "privKey" : "Example@234" } ] } }

响应示例 返回状态码为200：接口调用成功，响应体参考IPv6StaticRouteResponse。 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" : "", "success" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "FC00::1D4F/128", "nextHopType" : "ipv6-address", "ipv6Address" : "FC00::1D4F", "nextHopInterface" : "Tunnel0/0/400", "track" : true, "target" : "FC00::1D4F", "configSource" : "Wan", "isDefaultVpn" : false } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "FC00::1D4F/128", "nextHopType" : "ipv6-address", "ipv6Address" : "FC00::1D4F", "nextHopInterface" : "Tunnel0/0/400", "track" : true, "target" : "FC00::1D4F", "configSource" : "Wan", "isDefaultVpn" : 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的示例 PUT /controller/campus/v1/sdwan/routing-protocol/ipv6static 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 { "routes" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "FC00::1D4F/128", "nextHopType" : "ipv6-address", "ipv6Address" : "FC00::1D4F", "nextHopInterface" : "Tunnel0/0/400", "track" : true, "target" : "FC00::1D4F", "configSource" : "Wan", "isDefaultVpn" : false } ] }

响应示例 返回状态码为200：查询成功，响应体参考QueryTrafficFilterPolicyResponse。 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", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpnName", "name" : "app", "classificationProfileId" : "00000000-0000-0000-0000-000000000000", "classificationProfileName" : "classificationProfileName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "priority" : 1, "direction" : "inbound", "action" : "permit", "status" : 1, "isActive" : true, "bindMode" : "siteMode", "templateMode" : "classifier" } ] } 返回状态码为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/traffic-filter-policies?policyId=00000000-0000-0000-0000-000000000001&vpnId=00000000-0000-0000-0000-000000000001&policyName=acl 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：查询成功，响应体参考QueryTrafficFilterPolicyResponse。 表2 QueryTrafficFilterPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 流量过滤策略信息。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

接口约束 1、该接口仅支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、删除开局TNP后，若不想重新开局，需清除WAN业务。清除WAN业务后，将设备恢复开局配置再重新配置TNP，否则可能存在控制器和设备配置不一致的冲突。 3、如果TNP有重建需求，建议设置自定义的vrf和rd。 4、双网关场景需要同步删除两个网关下的TNP。 5、单次操作仅支持创建一个站点的数据。 6、新建TNP时，Eth-Trunk的范围是1~63。 7、FW网关设备仅支持GE、XGE、LTE、Eth-Trunk等接口开局。 8、FW网关设备从V600R024C00及以上版本支持IPv6。 9、FW网关设备从V600R024C00及以上版本支持PPPOE协议。 10、FW网关设备从V600R024C00版本开始支持开启IPv4 Overlay隧道。 11、FW网关设备不支持与网关AR设备混合开局。 12、FW网关设备不支持与FW非网关设备混合开局。 13、FW网关设备不支持DHCP开局模式。 14、iMaster NCE-Campus V300R024C10版本之前开局的V300系列设备默认按照原始IP进行限速，如果需要按照WAN接口实际发出报文限速，需要使能内环隧道带宽统计开销开关。

响应示例 返回状态码为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的示例 POST /controller/campus/v1/sdwan/net/transport-network-ports 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 { "multipleSubIfEnabled" : false, "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "enhancedMode" : false, "enableNtpAutoClient" : false, "tnps" : [ { "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 } ] }

请求示例 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-ACCESS-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：操作成功。 表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：内部错误。 详细信息请参见实际响应消息体。

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