华为云用户手册

响应示例 返回状态码为200：恢复开局配置成功，响应体参考ResetDeployResultDto。 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" : "", "successList" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "esn" : "AP05ZXV1230123456789", "name" : "LSW01", "result" : "LSW01" } ], "failList" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "00000000-0000-0000-0000-000000000000", "esn" : "AP05ZXV1230123456789", "name" : "LSW01", "result" : "LSW01" } ] } 返回状态码为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/v3/deploy/reset 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 { "deviceIdList" : [ "00000000-0000-0000-0000-000000000001" ] }

响应参数 返回状态码为200：恢复开局配置成功，响应体参考ResetDeployResultDto。 表3 ResetDeployResultDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码 "0" errmsg string - - 错误信息 "" successList ARRAY_REFERENCE 0-10000个列表项，详细请参见表4。 成功时返回的集合 - failList ARRAY_REFERENCE 0-10000个列表项，详细请参见表5。 失败时返回的集合 - 表4 DeviceObj对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string - - 设备ID "00000000-0000-0000-0000-000000000000" esn string - - 设备ESN 该字段对应UI页面上是：UI【ESN】 "AP05ZXV1230123456789" name string - - 设备名称 该字段对应UI页面上是：UI【名称】 "LSW01" result string - - 结果展示，失败时显示失败原因 "LSW01" 表5 FailDeviceObj对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" deviceId string - - 设备ID "00000000-0000-0000-0000-000000000000" esn string - - 设备ESN 该字段对应UI页面上是：UI【ESN】 "AP05ZXV1230123456789" name string - - 设备名称 该字段对应UI页面上是：UI【名称】 "LSW01" result string - - 结果展示，失败时显示失败原因 "LSW01" 返回状态码为500：恢复开局配置内部错误，无返回体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/endpointbehavior/capturerate?tagId=9dffc44b-1824-42a4-ac48-616e3f0eaa2a&tagType=0&startTime=1567526400&endTime=1567527800&timeUnit=day 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：接口调用成功，响应体参考FlowDistrResp。 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" : [ { "targetName" : "humanflow", "counts" : [ { "count" : "123", "stamp" : 1565049600000 } ] } ] } 返回状态码为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

URI /controller/campus/v1/performanceservice/endpointbehavior/capturerate 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tagId 否 string - - 查询维度具体id,UUID格式,根据tagType确定，当tagType为0或1时，tagId必填. "9dffc44b-1824-42a4-ac48-616e3f0eaa2a" tagType 是 string 0 1 2 - 查询类型： 0---站点维度查询，TagID为站点ID。 1---设备标签维度查询，TagID为设备标签ID。 2---租户维度查询，TagID不做校验，可为空。 "0" startTime 是 int32 - - 时间戳（秒），最大时间差不超过一年。 1567526400 endTime 是 int32 - - 时间戳（秒），最大时间差不超过一年。 1567527800 timeUnit 是 string day week month custom - 时间维度。 day---天维度 week---周维度 month---月维度 custom---自定义维度 "day"

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-if:nat-if 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-nat-if:nat-if" : { "if-name" : "GE0/0/3", "nat-enable" : true } }

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nat-if:nat-if 是 REFERENCE 详细请参见表4。 接口NAT配置。 - 表4 nes-ne-nat-if-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nat-if:nat-if 否 REFERENCE 详细请参见表5。 接口NAT配置。 - 表5 nat-if-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 if-name 否 string 1~63个字符。 - Interface name. "GE0/0/3" nat-enable 否 boolean true false - 启用/禁用nat功能。 true

响应示例 返回状态码为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-nat-if:nat-if 表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"

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nat-if:nat-if 是 REFERENCE 详细请参见表4。 接口NAT配置。 -

响应示例 返回状态码为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-nat-if:nat-if/{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个字符。 - Interface name. "GE0/0/3"

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-if:nat-if/GE0%2F0%2F3 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-nat-if:nat-if" : { "if-name" : "GE0/0/3", "nat-enable" : true } }

认证服务器侧的配置思路 本案例在认证服务器侧的配置过程如下： 创建认证规则Wireless_Guest_Authen，认证方式采用用户接入认证，用户数据源在本示例中采用的是短信验证码方式添加的本地数据源。 创建授权结果。系统的缺省授权结果包括允许接入和拒绝接入，如果不能满足需求，请根据实际需求创建新的授权结果。 创建授权规则Guest_Rule，认证方式采用用户接入认证，关联授权结果“允许接入”。

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:global-ip-pool/{ip-pool-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" ip-pool-name 是 string 1~128个字符。 - 名称，单一主键字段。 "pool1"

响应示例 返回状态码为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 { "huawei-nce-e-dhcpv4:global-ip-pool" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "gateway-list" : [ { "gateway-ip" : "10.1.1.1", "mask" : 24 } ], "section" : [ { "section-index" : 1, "start-ip" : "10.1.1.1", "end-ip" : "10.1.1.100" } ], "dns-list" : [ { "dns-ip" : "10.1.1.1" } ], "excluded-ip-address" : [ { "start-ip-address" : "10.1.1.10", "end-ip-address" : "10.1.1.20" } ], "static-bind" : [ { "static-bind-ip" : "10.1.1.1", "static-bind-mac" : "xxxx-xxxx-xxxx" } ], "option" : [ { "option-code" : 7, "ip-addresses" : [ "10.1.1.1" ], "ascii-string" : "test", "hex-string" : "00", "cipher-string" : "test@test", "sub-options" : { "sub-option" : [ { "sub-option-code" : 1, "ip-addresses" : [ "10.1.1.2" ], "ascii-string" : "test" } ] } } ], "ip-pool-name" : "pool1", "vpn-instance" : "overlay_vpn", "network-ipv4-address" : "10.1.1.0", "network-mask" : 24, "lease-time" : { "day" : 10, "hour" : 10, "minute" : 10, "unlimited" : true }, "domain-name" : "test.com" } ] } 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:global-ip-pool/pool1 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 /controller/campus/v1/sdwan/policy/traffic/redirect-policy/sites/{siteId}/action/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/redirect-policy/sites/00000000-0000-0000-0000-000000000000/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 { "vpnId" : "00000000-0000-0000-0000-000000000000", "fullReplace" : true, "redirectPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "设备1", "policyName" : "redirect1", "devicePolicyName" : "pbr_devciePolicyName_1", "portType" : "EvpnTunnel", "portId" : "00000000-0000-0000-0000-000000000000", "portName" : "redirect1", "direction" : "inbound", "description" : "描述", "redirectRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "流分类模板1", "behaviorId" : "00000000-0000-0000-0000-000000000000", "behaviorName" : "Behavior", "behaviorAction" : "permit" } ] } ] }

响应示例 返回状态码为200：删除成功，响应体参考RedirectPolicyResponse。 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" : "00000000-0000-0000-0000-000000000000", "fullReplace" : true, "redirectPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "设备1", "policyName" : "redirect1", "devicePolicyName" : "pbr_devciePolicyName_1", "portType" : "EvpnTunnel", "portId" : "00000000-0000-0000-0000-000000000000", "portName" : "redirect1", "direction" : "inbound", "description" : "描述", "redirectRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "流分类模板1", "behaviorId" : "00000000-0000-0000-0000-000000000000", "behaviorName" : "Behavior", "behaviorAction" : "permit" } ] } ] }, "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "fullReplace" : true, "redirectPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "设备1", "policyName" : "redirect1", "devicePolicyName" : "pbr_devciePolicyName_1", "portType" : "EvpnTunnel", "portId" : "00000000-0000-0000-0000-000000000000", "portName" : "redirect1", "direction" : "inbound", "description" : "描述", "redirectRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "流分类模板1", "behaviorId" : "00000000-0000-0000-0000-000000000000", "behaviorName" : "Behavior", "behaviorAction" : "permit" } ] } ] } } ] } 返回状态码为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

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

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-policy:nat-policy-rules/rules%40name 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-nat-policy:nat-policy-rules/{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~63个字符。 - 策略的名称，单一主键字段。 "rules@name"

响应参数 返回状态码为200：批量创建组织成功，响应体参考CreateOrgOut。 表3 CreateOrgOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - 0 错误码。当没有错误时返回0。 "0" errmsg string - 错误信息。当没有错误时返回空。 "" successList ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 创建成功的组织列表。 - failList ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 创建失败的组织列表。 - 表4 SuccessOrgInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 组织ID。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" name string - - 组织名称。 该字段对应UI页面上是：UI【组织名称】 "org1" parentId string - - 父组织ID。 "f296e87c-ea80-4045-ba00-537054d358a5" level int32 - - 组织所在层级。 "1" 表5 FailOrgInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 org string - - 组织ID/路径。 "/org1/org2" errcode string - - 失败的错误码。 "0" errmsg string - - 失败的错误信息。 ""

响应示例 返回状态码为200：批量创建组织成功，响应体参考CreateOrgOut。 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" : "", "successList" : [ { "id" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "name" : "org1", "parentId" : "f296e87c-ea80-4045-ba00-537054d358a5", "level" : "1" } ], "failList" : [ { "org" : "/org1/org2", "errcode" : "0", "errmsg" : "" } ] }

请求示例 HTTP的示例 POST /controller/campus/api/v1/organization/path 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 { "orgs" : ["/org1/org2","/org11/org22"], "cascade" : true }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-queue-template:user-queue-profile/{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~63个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 模板名称，单一主键字段。 "UserQueueProfile"

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-queue-template:user-queue-profile/UserQueueProfile 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-queue-template:user-queue-profile" : [ { "config-status" : "reserved", "last-committed-time" : "last-committed-time", "related-pkg-version" : "related-pkg-version", "edit-state" : "RUNNING", "name" : "UserQueueProfile", "mode" : "normal", "description" : "test", "traffic-behavior-user-queue" : [ { "name" : "name", "scheduler-mode" : "pq", "weight" : 10, "cir" : 64, "pir" : 10, "cir-percent" : 20, "pir-percent" : 30, "cbs" : 10, "pbs" : 10 } ] } ] }

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