华为云用户手册

响应示例 返回状态码为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-route-policy:nodes" : [ { "sequence" : 1, "match-mode" : "permit", "condition" : { "match-tag" : 1, "match-ipv4-type" : "ipv4-prefix", "match-ipv4-prefix" : "prefix1", "match-ipv6-type" : "ipv6-prefix", "match-ipv6-prefix" : "prefix1", "community-filter" : [ { "community-filter-name" : "communityFilterName1" } ], "ext-community-filter" : [ { "ext-community-filter-name" : "extCommunityFilterName1" } ] }, "action" : { "apply-tag" : 10, "apply-cost" : 10, "apply-local-preference" : 10, "apply-ext-community-color" : "100", "apply-community" : { "operation" : "replace", "set-community-type" : "inline", "communities" : [ "1:1" ] }, "apply-ext-community" : { "operation" : "replace", "ext-community-member" : [ { "value" : "1: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

请求示例 HTTP的示例 GET /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-AC CES S-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

响应参数 返回状态码为200：操作成功。 表3 nodes-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-route-policy:nodes ARRAY_REFERENCE 详细请参见表4。 节点。 - 表4 nes-ne-route-policy-exactProperties-nodes对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 sequence int64 [0-65535] - 序号，单一主键字段。 1 match-mode string permit deny - 匹配类型。 "permit" condition REFERENCE 详细请参见表6。 条件。 - action REFERENCE 详细请参见表9。 应用。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

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"

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ssl-policy:ssl-policies 是 REFERENCE 详细请参见表4。 Secure Socket Layer (SSL) -

响应示例 返回状态码为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-ssl-policy:ssl-policies/{policy-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" policy-name 是 string 1~23个字符。满足正则表达[a-z0-9_]*。 - ssl-policies名称配置,范围为1-23位小写字符,数字,下划线 "test1"

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ssl-policy:ssl-policies/test1 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-ssl-policy:ssl-policies" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "policy-name" : "test1", "pki-realm" : "default", "cert-file" : "Device-cert.pem", "key-file" : "Device-key.pem", "auth-code-cert" : "Huawei@123", "ca-file-one" : "SRV6_CA.cer", "auth-code-ca-one" : "ddddd", "ca-file-two" : "ddddd", "auth-code-ca-two" : "ddddd" } ] }

响应示例 返回状态码为201：创建成功，响应体参考DetectionUrlResponse。 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" : "000000-0000-0000-0000-000000000000", "appName" : "Google", "detectionUrl" : "https://huawei.com", "appType" : 1 } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "appName" : "Google", "detectionUrl" : "https://huawei.com", "appType" : 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

响应参数 返回状态码为201：创建成功，响应体参考DetectionUrlResponse。 表4 DetectionUrlResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 成功的应用探测URL信息列表。 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 失败的应用探测URL信息列表。 - 表5 DetectionUrlInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~64个字符。 - 应用探测URL ID，修改或删除的时候必填。 "000000-0000-0000-0000-000000000000" appName string 0~128个字符。 - 应用名称，创建的时候必填。取值的范围可参考接口/controller/campus/v1/sdwan/application/detection-url/configurable的返回。 "Google" detectionUrl string 0~230个字符。 - 应用探测URL，创建的时候必填。 "https://huawei.com" appType int32 [1-2] 1 应用类型，只用于查询场景。值范围：1表示预定义应用，2表示自定义应用。 1 表6 FailDetectionUrl对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x00c8000c" errmsg string - - 错误信息。 "The parameter is invalid." data REFERENCE 详细请参见表5。 失败的应用探测URL信息。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/application/detection-url 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 { "detectionUrlInfos" : [ { "id" : "000000-0000-0000-0000-000000000000", "appName" : "Google", "detectionUrl" : "https://huawei.com", "appType" : 1 } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 addDetectionUrlReq 是 REFERENCE 详细请参见表2。 应用探测URL信息。 - 表2 DetectionUrlInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 detectionUrlInfos 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 应用探测URL列表。 - 表3 DetectionUrlInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 string 0~64个字符。 - 应用探测URL ID，修改或删除的时候必填。 "000000-0000-0000-0000-000000000000" appName 否 string 0~128个字符。 - 应用名称，创建的时候必填。取值的范围可参考接口/controller/campus/v1/sdwan/application/detection-url/configurable的返回。 "Google" detectionUrl 否 string 0~230个字符。 - 应用探测URL，创建的时候必填。 "https://huawei.com" appType 否 int32 [1-2] 1 应用类型，只用于查询场景。值范围：1表示预定义应用，2表示自定义应用。 1

响应示例 返回状态码为200：删除成功，响应体参考DeleteUserOutputDto。 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" : ["35da2f2e-f29d-4ae2-b81e-0142a309f6de"], "fail" : [ { "errcode" : "0308000221", "errmsg" : "The selected user does not exist", "data" : "51cdcbe3-5e14-492b-ab27-86950b661d19" } ] } 返回状态码为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/accountservice/users/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 { "allUserIds" : ["35da2f2e-f29d-4ae2-b81e-0142a309f6de","51cdcbe3-5e14-492b-ab27-86950b661d19"] }

响应示例 返回状态码为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 { "errcode" : "0", "errmsg" : "", "data" : { "vlanId" : "10", "vlanName" : "vlan10", "vlanDesc" : "vlan10", "ipSubnetVlan" : ["10.100.100.100/24","10.101.100.100/24","10.102.100.100/24","10.103.100.100/24","10.104.100.100/24","10.105.100.100/24","10.106.100.100/24","10.107.100.100/24","10.108.100.100/24","10.109.100.100/24","10.110.100.100/24","10.111.100.100/24"], "unknownFlowDrop" : false, "arpSnoopingEnable" : false, "igmpSnoopingEnable" : false, "igmpSnoopingQuerierEnable" : false, "id" : "813a76d4-6eec-4264-ae45-a6f261482b60" } } 返回状态码为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

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/lswglobalvlan/devices/fbb684c8-0d37-496f-bafa-4b06d515abcd/globalvlan 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 { "vlanId" : "10", "vlanName" : "vlan10", "vlanDesc" : "vlan10", "ipSubnetVlan" : ["10.100.100.100/24","10.101.100.100/24","10.102.100.100/24","10.103.100.100/24","10.104.100.100/24","10.105.100.100/24","10.106.100.100/24","10.107.100.100/24","10.108.100.100/24","10.109.100.100/24","10.110.100.100/24","10.111.100.100/24"], "unknownFlowDrop" : false, "arpSnoopingEnable" : false, "igmpSnoopingEnable" : false, "igmpSnoopingQuerierEnable" : false }

URI /controller/campus/v1/networkservice/networkconfig/net/lswglobalvlan/devices/{deviceId}/globalvlan 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d515abcd"

响应参数 返回状态码为200：接口调用成功，响应体参考LldpCollectStatisticsResp。 表2 LldpCollectStatisticsResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 接口调用结果的描述信息。 "" id string - - 任务ID。 "ee4d21b7-27cf-4b2e-af7a-8231a31152c0" status int32 - - 任务状态 1：开始；2：结束。 1 createTime int64 - - 任务创建时间。 1612853177000 updateTime int64 - - 任务刷新时间。 1612853226000 statistics ARRAY_REFERENCE 详细请参见表3。 LLDP采集统计信息 - 表3 LldpCollectDeviceStatistics对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 源设备ID。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" name string - - 源设备名称。 "00500829380000000000" neighbourDevNum int32 - - 每个源设备采集的设备总数，为0可能是无邻居设备或者设备离线或者采集超时或者LLDP开关未打开。 100 allowAddNeighbourDevNum int32 - - 每个源设备采集的允许添加设备总数，需要去除已经添加的设备数，为0可能是设备已添加到控制器或者无邻居设备或者设备离线或者采集超时或者LLDP开关未打开。 100 返回状态码为400：接口参数校验异常，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/api/v1/devices/lldp/scan/statistics?taskId=ee4d21b7-27cf-4b2e-af7a-8231a31152c0 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：接口调用成功，响应体参考LldpCollectStatisticsResp。 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" : "", "id" : "ee4d21b7-27cf-4b2e-af7a-8231a31152c0", "status" : 1, "createTime" : 1612853177000, "updateTime" : 1612853226000, "statistics" : [ { "id" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "name" : "00500829380000000000", "neighbourDevNum" : 100, "allowAddNeighbourDevNum" : 100 } ] } 返回状态码为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

请求示例 HTTP的示例 POST /controller/campus/api/v1/lswauth/wireless/20ab206c-5f5f-4cb6-9090-05cda5e9727b HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "name":"test6666", "ssidName":"test6666", "authMode":1, "escapeStrategy":0, "preAuthPrivilege":{ "preAuthPrivilegeEnable":false, "vlan":"" }, "authFailPrivilege":{ "authFailPrivilegeEnable":false, "vlan":"" }, "voiceDeviceNoAuth":{ }, "portalConfigDto":{ "pagePushMode":0, "freeAuthEnable":false, "internalPortalConfigDto":{ "portalProtocol":0, "pushProtocol":0, "pushMethod":0, "ipv6Enable":false, "accountingEnable":false, "accountingPeriod":null, "pushPageId":"9012b661-1750-4338-b84d-8ecf672bb790", "pushPageName":"默认用户名密码认证定制页面", "normalAccessConfigDto":{ "registerEnable":false, "userExpiredTime":null } } } }

响应示例 返回状态码为201：创建认证模板成功，响应体参考LswAuthConfigResponse。 HTTPS 201 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0", "errmsg":"", "data":[ { "id":"64b15bd66c8f44c086994e35b32aac1c", "name":null, "ssidName":null, "authMode":null, "escapeStrategy":null, "escapeStrategyId":null, "escapePolicyName":null, "apFreeAuthEnable":null, "forceDomainEnable": true, "preAuthPrivilege":null, "authFailPrivilege":null, "voiceDeviceNoAuth":null, "hasPermission":null, "portalConfigDto":null, "radiusConfigDto":null } ] } 返回状态码为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/net/available-ports?deviceId=00000000-0000-0000-0000-000000000000&siteId=00000000-0000-0000-0000-000000000000&type= &count=5 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：接口调用成功，响应体参考QueryAvailablePortResponse。 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" : [ "10-20" ] } 返回状态码为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/net/available-ports 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 否 uuid - - 设备ID，必填。 "00000000-0000-0000-0000-000000000000" siteId 否 uuid - - 站点ID，必填。 "00000000-0000-0000-0000-000000000000" type 是 string 0~64个字符。 - 端口号类型，可选值：tunnel、loopback。 - count 否 int32 - 5 查询的最大端口段数量，默认为5。 5

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteConfig 是 REFERENCE 详细请参见表2。 更新站点高级配置信息。 - 表2 SiteConfigInfoRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 SiteConfigInfos 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表2。 - -

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/site/advanced/batch-config 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 { "SiteConfigInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "macType" : "real", "avoidMissingEnable" : false } ] }

响应参数 返回状态码为200：正常响应 表3 SiteConfigBatchResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码，0表示成功，非0表示失败。 "0" errmsg string 0~256个字符。 - 错误信息 "error" data ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 - - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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" : "error", "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "macType" : "real", "avoidMissingEnable" : 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/policy/security/zone/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 { "securityInfo" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } ] }