华为云用户手册

响应示例 返回状态码为200：查询成功，响应体参考BatchQueryResult。 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 { "errorCode" : "0x00c80035", "errorMessage" : "参数非法", "totalCounts" : "", "deviceList" : [ { "siteName" : "siteName", "siteId" : "00000000-0000-0000-0000-000000000001", "deviceType" : "LSW", "deviceModel" : "USG6380", "role" : "ACC", "id" : "00000000-0000-0000-0000-000000000001", "esn" : "0088032VRE1234567890", "name" : "name", "firstConnectTime" : "1686532310230", "lastConnectTime" : "1686532310230", "approvalStatus" : 1, "failReason" : "设备类型不匹配", "nameModifyFlag" : "true", "siteModifyFlag" : "true", "stackMasterEsn" : "0088032VRE1234567890", "mac" : "01-80-C2-00-00-00", "discoveryType" : 1, "discoveryParentId" : "00000000-0000-0000-0000-000000000001" } ] } 返回状态码为400：设备ID格式错误时返回，响应体参考ErrorResponse。 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 { "errorCode" : "0x00c80035", "errorMessage" : "参数非法" } 返回状态码为500：服务内部异常时返回，响应体参考ErrorResponse。 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 { "errorCode" : "0x00c80035", "errorMessage" : "参数非法" }

响应参数 返回状态码为200：查询成功，响应体参考BatchQueryResult。 表3 BatchQueryResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode string 1~128个字符。 - 错误码 "0x00c80035" errorMessage string 1~128个字符。 - 错误原因 "参数非法" totalCounts int32 [0-200000] - 数据总数 - deviceList ARRAY_REFERENCE 0-300个列表项，详细请参见表4。 设备信息 - 表4 DeviceApprovalDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteName string 2~32个字符。 - 站点名 该字段对应UI页面上是：UI【站点】 "siteName" siteId string 1~64个字符。 - 站点id "00000000-0000-0000-0000-000000000001" deviceType string 1~10个字符。 - 设备类型 该字段对应UI页面上是：UI【类型】 "LSW" deviceModel string 1~32个字符。 - 设备型号 该字段对应UI页面上是：UI【设备型号】 "USG6380" role string 1~10个字符。 - 设备角色 该字段对应UI页面上是：UI【角色】 "ACC" id string 1~64个字符。 - 设备id "00000000-0000-0000-0000-000000000001" esn string 1~64个字符。 - 设备ESN 该字段对应UI页面上是：UI【ESN】 "0088032VRE1234567890" name string 1~256个字符。 - 设备名称 该字段对应UI页面上是：UI【设备名称】 "name" firstConnectTime string 1~16个字符。 - 初次连接时间 该字段对应UI页面上是：UI【初次连接时间】 "1686532310230" lastConnectTime string 1~16个字符。 - 最后连接时间 该字段对应UI页面上是：UI【最后连接时间】 "1686532310230" approvalStatus int32 [0-2] - 审批状态 1 failReason string 1~32个字符。 - 失败原因 该字段对应UI页面上是：UI【失败原因】 "设备类型不匹配" nameModifyFlag string 1~8个字符。 - 是否修改过名称 "true" siteModifyFlag string 1~8个字符。 - 是否修改过站点 "true" stackMasterEsn string 1~64个字符。 - 堆叠主esn "0088032VRE1234567890" mac string 1~32个字符。 - 一体机从设备的MAC "01-80-C2-00-00-00" discoveryType int32 [1-2] - 发现渠道 1、免ESN发现 2、一体机发现 1 discoveryParentId string 1~64个字符。 - 一体机设备ID "00000000-0000-0000-0000-000000000001" 返回状态码为400：设备ID格式错误时返回，响应体参考ErrorResponse。 表5 ErrorResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode string 1~128个字符。 - 错误码 "0x00c80035" errorMessage string 1~128个字符。 - 错误原因 "参数非法" 返回状态码为500：服务内部异常时返回，响应体参考ErrorResponse。 ErrorResponse对象的参数列表，详细请参见表5。

请求示例 HTTP的示例 POST /v1/devicemgr/access-approvals/action/batch-query 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 { "keyWord" : "00000", "deviceTypes" : ["AP","LSW"], "siteIds" : ["00000000-0000-0000-0000-000000000001"], "pageIndex" : 1, "pageSize" : 20, "status" : [1,2], "discoveryType" : [1,2] }

响应参数 返回状态码为200：修改NTP成功，响应体参考NtpResponse。 表5 NtpResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-10个列表项，详细请参见表4。 成功的NTP信息列表。 - fail ARRAY_REFERENCE 0-10个列表项，详细请参见表6。 失败的NTP信息列表。 - 表6 FailNtpInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表4。 - - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：修改NTP成功，响应体参考NtpResponse。 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" : [ { "tnpId" : "b09a0266-f34e-125d-ce23-ad1278b6c590", "vpnId" : "b09a0266-f34e-125d-ce23-ad1278b6c590", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "sourceInterfaceId" : "LoopBack610", "ntpInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 10 } } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "tnpId" : "b09a0266-f34e-125d-ce23-ad1278b6c590", "vpnId" : "b09a0266-f34e-125d-ce23-ad1278b6c590", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "sourceInterfaceId" : "LoopBack610", "ntpInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 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

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/ntp 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" : "a99f794e-b510-438c-a75d-de59f02347eb", "enableServerAuthentication" : true, "authenKey" : "", "authKeyId" : "12", "enableAutoClient" : false, "ntps" : [ { "tnpId" : "b09a0266-f34e-125d-ce23-ad1278b6c590", "vpnId" : "b09a0266-f34e-125d-ce23-ad1278b6c590", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "sourceInterfaceId" : "LoopBack610", "ntpInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 10 } } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ntpInfos 是 REFERENCE 详细请参见表2。 修改NTP对象。 - 表2 NtpInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 uuid - - 站点ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" enableServerAuthentication 否 boolean true false - 是否开启server认证。只有站点角色为边缘站点和控制站点合设时支持开启。默认为false。 true authenKey 否 string 0~255个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 认证密码，enableServerAuthentication开启时必填。V300系列设备密码长度必须在6-255位,且必须满足复杂度，即必须包含特殊字符（"`!@#$%^&()_+=-[]{},.;）、英文大写字母（A~Z）、英文小写字母（a~z）、数字（0~9）中的任意两种组合及以上。V600系列设备仅V600R021C00及之后版本设备的密码必须包含12-255个字符，并且必须包含以下内容：大写字母，小写字母，数字和特殊字符（"`!@#$%^&()_+=-[]{},.;）。 - authKeyId 否 string 0~32个字符。 - authenKeyId。enableServerAuthentication开启时必填。范围0~32，不能与客户端模式中手工配置下的认证ID重复。 "12" enableAutoClient 否 boolean true false - 是否开启客户端跟随父站点。只有站点角色为边缘站点时支持开启，当开启开关后，无需再手工配置链路的TNP配置。默认为false。 false ntps 否 ARRAY_REFERENCE 0-256个列表项，详细请参见表3。 手工配置ntp详情 - 表3 ManualNtpInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tnpId 否 string 0~64个字符。 - TNP ID，UUID格式。 "b09a0266-f34e-125d-ce23-ad1278b6c590" vpnId 否 string 0~64个字符。 - overlay网络上的VPN ID，UUID格式。 "b09a0266-f34e-125d-ce23-ad1278b6c590" deviceId 否 uuid - - 设备ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" sourceInterfaceId 否 string 0~32个字符。 - NTP服务器部署在overlay网络时，client接入server的源接口 "LoopBack610" ntpInfo 否 REFERENCE 详细请参见表4。 - - 表4 NtpInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - NTP ID，uuid格式。 "00000000-0000-0000-0000-000000000000" ntpType 否 string 4个字符。 IPv4 NTP服务器地址类型，取值范围：IPv4、IPv6。 "IPv6" preferEn 否 boolean true false false 是否指定该远程服务器为优先选择的服务器。 false serverIP 是 string 0~39个字符。 - NTP服务器地址。当ntpType为IPv4，serverIp为IPv4地址，如：192.168.1.1；当ntpType为IPv6，serverIp为IPv6地址，如：fc00:3::1。 "fc00:3::1" authentication 是 boolean true false false 是否认证。 false mode 否 string 0~16个字符。 - 认证模式，取值范围：MD5、HMAC-SHA256。当authentication为true时，mode必填。V600版本设备不支持MD5。 "HMAC-SHA256" authKey 否 string 6~255个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 认证密码，当authentication为true时，authKey必填。V300系列设备密码长度必须在6-255位,且必须满足复杂度，即必须包含特殊字符（"`!@#$%^&()_+=-[]{},.;）、英文大写字母（A~Z）、英文小写字母（a~z）、数字（0~9）中的任意两种组合及以上。V600系列设备仅V600R021C00及之后版本设备的密码必须包含12-255个字符，并且必须包含以下内容：大写字母，小写字母，数字和特殊字符（"`!@#$%^&()_+=-[]{},.;）。建议密码长度配置在12位以上。 "******" authId 否 int64 - - 认证ID。取值范围：1-4294967295，其中V600版本设备在配置IPv6服务器时最大值为65535。当authentication为true时，authId必填。 10

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/classification-profiles/action/batch-delete 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 { "classificationProfiles" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "app", "operator" : "and", "aclType" : "ipv4", "l3Acls" : [ { "priority" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePort" : 1, "sourcePortEnd" : 1, "destinationPort" : 1, "destinationPortEnd" : 1, "dscp" : 1, "protocolNum" : 1, "tcpFlag" : "ack,fin" } ], "applicationGroupIds" : [ "00000000-0000-0000-0000-000000000000" ], "enableVlanRange" : false, "vlanRange" : { "start" : 1, "end" : 4094 }, "enableP8021" : false, "p8021" : 1, "enableSourceMac" : false, "sourceMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableDestinationMac" : false, "destinationMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableL2Protocol" : false, "l2ProtocolNum" : "0x0800", "adn" : false, "experienceLevel" : "", "applyType" : "FW", "sourceIps" : [ "10.1.1.2/32" ], "sourceIpSets" : [ "sourceIp" ], "sourceDomainSets" : [ "domainSet" ], "destIps" : [ "10.1.1.2/32" ], "destIpSets" : [ "destIp" ], "destDomainSets" : [ "domainSet" ], "protocols" : [ { "name" : "TCP", "protocolNum" : 6, "srcPort" : "0-65535", "dstPort" : "0-65535" } ] } ] }

响应示例 返回状态码为200：删除成功，响应体参考ClassificationProfileResponse。 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" : "00000000-0000-0000-0000-000000000000", "name" : "app", "operator" : "and", "aclType" : "ipv4", "l3Acls" : [ { "priority" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePort" : 1, "sourcePortEnd" : 1, "destinationPort" : 1, "destinationPortEnd" : 1, "dscp" : 1, "protocolNum" : 1, "tcpFlag" : "ack,fin" } ], "applicationGroupIds" : [ "00000000-0000-0000-0000-000000000000" ], "enableVlanRange" : false, "vlanRange" : { "start" : 1, "end" : 4094 }, "enableP8021" : false, "p8021" : 1, "enableSourceMac" : false, "sourceMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableDestinationMac" : false, "destinationMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableL2Protocol" : false, "l2ProtocolNum" : "0x0800", "adn" : false, "experienceLevel" : "", "applyType" : "FW", "sourceIps" : [ "10.1.1.2/32" ], "sourceIpSets" : [ "sourceIp" ], "sourceDomainSets" : [ "domainSet" ], "destIps" : [ "10.1.1.2/32" ], "destIpSets" : [ "destIp" ], "destDomainSets" : [ "domainSet" ], "protocols" : [ { "name" : "TCP", "protocolNum" : 6, "srcPort" : "0-65535", "dstPort" : "0-65535" } ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "app", "operator" : "and", "aclType" : "ipv4", "l3Acls" : [ { "priority" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePort" : 1, "sourcePortEnd" : 1, "destinationPort" : 1, "destinationPortEnd" : 1, "dscp" : 1, "protocolNum" : 1, "tcpFlag" : "ack,fin" } ], "applicationGroupIds" : [ "00000000-0000-0000-0000-000000000000" ], "enableVlanRange" : false, "vlanRange" : { "start" : 1, "end" : 4094 }, "enableP8021" : false, "p8021" : 1, "enableSourceMac" : false, "sourceMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableDestinationMac" : false, "destinationMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableL2Protocol" : false, "l2ProtocolNum" : "0x0800", "adn" : false, "experienceLevel" : "", "applyType" : "FW", "sourceIps" : [ "10.1.1.2/32" ], "sourceIpSets" : [ "sourceIp" ], "sourceDomainSets" : [ "domainSet" ], "destIps" : [ "10.1.1.2/32" ], "destIpSets" : [ "destIp" ], "destDomainSets" : [ "domainSet" ], "protocols" : [ { "name" : "TCP", "protocolNum" : 6, "srcPort" : "0-65535", "dstPort" : "0-65535" } ] } } ] } 返回状态码为204：执行成功，无响应体。 HTTP/1.1 204 No Content 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/oamservice/certification/caservertemplate 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：查询成功，响应体参考QueryCAServerResponse。 表1 QueryCAServerResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-20个列表项，详细请参见表2。 SCEP CA服务器信息。 - dataV2 ARRAY_REFERENCE 0-2个列表项，详细请参见表2。 CMPv2 CA服务器信息。 - 表2 CAServerInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 caServerId string - - CA服务器ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" caName string 0~64个字符。 - CA服务器名称。 "cusCA" caUrl string 0~128个字符。 - CA服务器http方式SCEP证书申请URL。 "http://host:port/certsrv/mscep/mscep.dll" caHttpsUrl string 0~128个字符。 - CA服务器https方式SCEP证书申请URL。 "https://host:port/certsrv/mscep/mscep.dll" 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

接口约束 1、NCE-Campus LANWAN场景该接口支持租户视图或支持msp视图下，角色为“Open Api Operator”或“Open Api Monitor”的用户访问，必须在用户会话建立后使用； 2、NCE-Campus LAN场景该接口仅支持租户视图或msp代维视图下，角色为“Open Api Operator”或“Open Api Monitor”的用户访问，必须在用户会话建立后使用。

响应示例 返回状态码为200：查询成功，响应体参考QueryCAServerResponse。 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" : [ { "caServerId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "caName" : "cusCA", "caUrl" : "http://host:port/certsrv/mscep/mscep.dll", "caHttpsUrl" : "https://host:port/certsrv/mscep/mscep.dll" } ], "dataV2" : [ { "caServerId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "caName" : "cusCA", "caUrl" : "http://host:port/certsrv/mscep/mscep.dll", "caHttpsUrl" : "https://host:port/certsrv/mscep/mscep.dll" } ] } 返回状态码为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/networkservice/networkconfig/net/wactunnel/fbb684c8-0d37-496f-bafa-4b06d5151e2e/bind-relation 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 { "esns" : [ "AA02354LHM1234567890" ], "siteId" : "acc846c5-2fff-694d-2b2d-12dff3d1231a" }

响应参数 返回状态码为200：修改成功。 表4 WACTunnelServiceResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-1000个列表项，详细请参见表4。 隧道配置列表。 -

URI /controller/campus/v1/networkservice/networkconfig/net/wactunnel/{wacId}/bind-relation 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 wacId 是 string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为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" : [ { "deviceId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "esn" : "AP50082935AAAAAAAAA1", "status" : 0, "tunnelId" : 1 } ] }

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ipv4:ipv4/Vbdif1 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"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ipv4:ipv4/{if-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" if-name 是 string 1~63个字符。 - 接口名称，AR6700V仅支持类型为Vbdif、LoopBack的接口，单一主键字段。 "Vbdif1"

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

接口约束 该接口支持msp视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V和AR6700V子设备； 或者支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V-L款型。 该API可能会直接或间接影响现网业务运行，导致业务中断、关键数据丢失等，请谨慎操作！

响应参数 返回状态码为200：重置成功。 表4 ClearTimeFlowStResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 1-100个列表项，详细请参见表5。 清理用户流量详情列表。 - 表5 ClearTimeFlowStDetailResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string - - 错误码。 "0" errMsg string - - 错误信息。 "" timeFlowStType string - - 流量时长类型，用户级(user)和终端级(terminal)。 "user" clearType string - - 重置流量或时长类型。 "flow" timeFlowStInfo REFERENCE 详细请参见表5。 用户流量信息详情。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/accountservice/user/timeflowstinfos/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/reset-timeflow 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 { "timeFlowStType" : "user", "clearType" : "flow", "clearDtoList" : ["d5f17ddd0b25471bb0109d32cbc3a724"] }

响应示例 返回状态码为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" : [ { "errCode" : "0", "errMsg" : "", "timeFlowStType" : "user", "clearType" : "flow", "timeFlowStInfo" : { "id" : "d5f17ddd0b25471bb0109d32cbc3a724", "siteId" : "351e1696-02a2-4a68-bad4-aa639359c222", "userName" : "1", "lastChargeTime" : "1545812248932", "usedFlow" : "100", "usedTime" : "20", "policyFlow" : "111111", "policyTime" : "2222", "remianFlow" : "111011", "remianTime" : "2202", "loginIp" : "10.1.1.1", "terminalMac" : "22-22-22-22-22-22", "oneOnlinePolicyTime" : "2211", "oneOnlineUsedTime" : "11", "oneOnlineRemainTime" : "2200" } } ] } 返回状态码为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/accountservice/user/timeflowstinfos/sites/{siteId}/reset-timeflow 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为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" : "Success", "data" : { "id" : "512", "name" : "随流检测", "profileId" : "9a157da3-9e59-41c9-8312-254a38a3b275", "enable" : true, "dscp" : 63, "vpnPorts" : [ { "operate" : 0, "interfaceName" : "GigabiEthernet0/0/1", "deviceName" : "设备001", "deviceId" : "9a157da3-9e59-41c9-8312-254a38a3b275", "vpnId" : "9a157da3-9e59-41c9-8312-254a38a3b276", "vpnName" : "vpn1" } ] } } 返回状态码为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 FlowDetailOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "Success" data REFERENCE 详细请参见表3。 流数据 - 表3 FlowData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~5个字符。 - 流id "512" name string 1~256个字符。 - 指定流名称 "随流检测" profileId string 1~36个字符。 - 识别流模板ID "9a157da3-9e59-41c9-8312-254a38a3b275" enable boolean true false true 启用状态 true dscp int32 [0-63] - 静态流排序号 63 vpnPorts ARRAY_REFERENCE 0-1000个列表项，详细请参见表4。 设备接口接口信息 - 表4 VpnPort对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 operate int32 [0-2] 0 增量接口操作增删 0-增加 1-删除 2-修改 0 interfaceName string 1~36个字符。 - 接口名称 "GigabiEthernet0/0/1" deviceName string 0~256个字符。 - 设备名称 "设备001" deviceId string 1~36个字符。 - 设备id "9a157da3-9e59-41c9-8312-254a38a3b275" vpnId string 0~36个字符。 - vpn id "9a157da3-9e59-41c9-8312-254a38a3b276" vpnName string 0~256个字符。 - vpn名称 "vpn1" 返回状态码为400：查询随流检测配置数据失败后的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考VpnRoutePolicyResponse。 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" : [ { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] } } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] } } } ] } 返回状态码为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/overlay-network/vpn/route-policy 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" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20000, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "matchMode" : "permit", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "ipv6Prefix" : { "name" : "", "ipv6PrefixFilters" : [ { "matchMode" : "permit", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "filterName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "10" ] } ], "wholeMatch" : false } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "100" ], "additive" : false, "none" : false }, "applyExtCommunity" : { "rtFilters" : [ "100:1" ], "additive" : false }, "applyAsPath" : { "asNumbers" : [ "100" ], "additive" : false, "overwrite" : false, "none" : false }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20001 } } ] } } ]

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/time/sites/fbb684c8-0d37-496f-bafa-4b06db151e2e/times 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