华为云用户手册

URI /controller/campus/api/campusoamservice/v1/cpe/cli/tasks 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryParam 是 string 0~1024个字符。 - 查询任务状态请求体。 "pageSize::10|pageIndex::1|sort::configTime|keyword::test|status::0"

响应示例 返回状态码为200：清楚成功，响应体参考ResetResponse。 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" : "" } 返回状态码为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：清楚成功，响应体参考ResetResponse。 表4 ResetResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 additionalInfo 是 REFERENCE 详细请参见表3。 请求参数 - 表3 MacDeleteInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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" macType 是 string all sticky - mac类型。 "all"

请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/mactable/00000000-0000-0000-0000-000000000000/batch-delete 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 { "searchType" : "all", "macAddr" : "xx-xx-xx-xx-xx-xx", "idType" : "vlan", "id" : "1", "interfaceId" : "XGigabitEthernet0/0/1", "macType" : "all" }

响应示例 返回状态码为200：修改成功，返回结构体参见DomainNameResponseDto。 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" : { "domainName" : "www.example.com" } }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/domainname/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/domainnames 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 { "domainName" : "www.example.com" }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 站点内设备 域名 配置参数体,结构体参见DomainNameDto。 - 表3 DomainNameDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 domainName 是 string 1~255个字符。满足正则表达[a-zA-Z0-9_\-\.]*$。 - 设备域名。 "www.example.com"

URI /controller/campus/v1/networkservice/networkconfig/net/domainname/sites/{siteId}/domainnames 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/security/attackdefense/switch/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 { "enable" : true, "attackTypes" : ["fraggle","icmp-flood"] }

响应示例 返回状态码为201：更改成功，响应体参考防范攻击AttackDefenseInfoResponse。 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" : "OK", "errmsg" : "参数缺失", "data" : { "enable" : true, "attackTypes" : ["fraggle","icmp-flood"] } } 返回状态码为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 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-route-policy:route-policy 表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"

响应示例 返回状态码为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:route-policy" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "policy1", "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

响应参数 返回状态码为200：查询返回的动态ACL模板信息。 表1 QueryDynamicAclRet对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 查询匹配到的动态ACL模板总数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 返回的动态ACL模板记录信息。 -

响应示例 返回状态码为200：查询返回的动态ACL模板信息。 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, "data" : [ { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "ACLTemplate1", "description" : "ACLTemplate1", "dynamicRuleList" : [ { "ruleId" : "10000", "policy" : "permit", "protocol" : "tcp", "dstIp" : "192.168.2.0/24", "dstPort" : "24" } ] } ] }

URI /controller/campus/v1/networkservice/networkconfig/net/localuser/sites/{siteId}/users/{username} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" username 是 string 0~64个字符。 - 本地用户名，在URL中拼接用户名时，要对特殊字符转义。 "test"

响应示例 返回状态码为200：修改成功，返回信息，结构体参见updateLocalUserInfoResponse。 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" : { "password" : "********", "role" : 1, "serviceType" : [ "ssh" ], "configRu" : false } }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/localuser/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/users/test 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 { "password" : "Iam@example", "role" : 1, "serviceType" : ["http","ssh","terminal"], "configRu" : false }

请求示例 HTTP的示例 POST /v1/performanceservice/flow/instances HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "name" : "指定流名称", "profileId" : "9a157da3-9e59-41c9-8312-254a38a3b275", "profileName" : "识别流模板名称", "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" } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 flowInput 否 REFERENCE 详细请参见表2。 随流检测配置 - 表2 FlowInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~256个字符。 - 指定流名称 "指定流名称" profileId 否 string 1~36个字符。 - 识别流模板id "9a157da3-9e59-41c9-8312-254a38a3b275" profileName 否 string 0~256个字符。 - 识别流模板名称 "识别流模板名称" enable 否 boolean true false true 启用状态 true-打开 false-关闭 true dscp 否 int32 [0-63] - 静态流排序号 63 vpnPorts 否 ARRAY_REFERENCE 0-200个列表项，详细请参见表3。 设备接口接口信息 - 表3 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"

响应参数 返回状态码为201：设置随流检测配置成功后的状态返回码。 表4 FlowConfigOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "Success" id string 0~5个字符。 - 流id "512" 返回状态码为400：接口更新失败后的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为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 { "errcode" : "0", "errmsg" : "Success", "id" : "512" } 返回状态码为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：查询成功，响应体参考QueryDynamicQosDetailResponse。 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" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "qos1", "adaptiveQosEnable" : false, "adaptiveQosInfo" : { "period" : 10, "linkBandwidthLowerThreshold" : 1, "appBandwidthLowerThreshold" : 1, "packetLossThreshold" : 1 }, "queryPeerSites" : { "totalRecords" : 1, "pageIndex" : 1, "pageSize" : 10, "peerSites" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "templateName", "bandwidth" : 10 } ] }, "queryDynamicQosRules" : { "totalRecords" : 1, "pageIndex" : 1, "pageSize" : 10, "dynamicQosRules" : [ { "qosRuleId" : "00000000-0000-0000-0000-000000000000", "qosClassificationId" : "00000000-0000-0000-0000-000000000000", "qosClassificationName" : "qosClassificationName", "qosProfileId" : "00000000-0000-0000-0000-000000000000", "qosProfileName" : "templateName", "qosPriority" : 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的示例 POST /controller/campus/v1/sdwan/policy/traffic/dynamic/qos/00000000-0000-0000-0000-000000000000/detail 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 { "peerSitePageInfo" : { "pageIndex" : 1, "pageSize" : 20 }, "qosRulePageInfo" : { "pageIndex" : 1, "pageSize" : 20 } }

响应参数 返回状态码为200：查询成功，响应体参考QueryDynamicQosDetailResponse。 表5 QueryDynamicQosDetailResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表6。 动态QoS策略策略信息。 - 表6 QueryDynamicQosPolicyDetail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid 0~64个字符。 - 策略ID，UUID格式。 "00000000-0000-0000-0000-000000000000" name string 0~64个字符。 - 策略名称。 "qos1" adaptiveQosEnable boolean true false false 是否开启自适应QoS。 false adaptiveQosInfo REFERENCE 详细请参见表11。 自适应QoS相关数据信息。 - queryPeerSites REFERENCE 详细请参见表7。 HUB站点对端站点id列表。 - queryDynamicQosRules REFERENCE 详细请参见表8。 子策略列表。 - 表7 QueryPeerSites对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 totalRecords int32 [0-1200] - 总的数据条数。 1 pageIndex int32 [0-65535] - 当前页数。 1 pageSize int32 [0-65535] - 每页显示数量。 10 peerSites ARRAY_REFERENCE 0-1200个列表项，详细请参见表9。 HUB站点对端站点id列表。 - 表8 QueryDynamicQosRules对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 totalRecords int32 [0-68] - 总的数据条数。 1 pageIndex int32 [0-65535] - 当前页数。 1 pageSize int32 [0-65535] - 每页显示数量。 10 dynamicQosRules ARRAY_REFERENCE 0-68个列表项，详细请参见表10。 QoS子策略列表。 - 返回状态码为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" : "", "data" : { "id" : "fbde1c5d-5b94-49e3-a912-48641015e451", "name" : "siteTemplate1", "types" : [ "AP" ], "capabilities" : ["AP","FW","LSW"], "custom" : true, "configIdentifies" : "snmp" }, "list" : [ { "id" : "fbde1c5d-5b94-49e3-a912-48641015e451", "name" : "siteTemplate1", "types" : [ "AP" ], "capabilities" : ["AP","FW","LSW"], "custom" : true, "configIdentifies" : "snmp" } ] } 返回状态码为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：成功创建的站点模板信息。 表3 CopySiteTempResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~1000个字符。 0 错误码。 "0" errmsg string 0~1000个字符。 错误信息。 "" data REFERENCE 详细请参见表4。 站点模板数据。 - list ARRAY_REFERENCE 0-1000个列表项，详细请参见表4。 批量复制的站点模板数据。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/site-templates/duplication HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "name" : "siteTemplate1", "oriTemplateId" : "75b930a2-11c7-4612-af1c-75b930a2", "cloneType" : "CLONE_SINGLE", "destPath" : "CURRENT_PATH" }

响应示例 返回状态码为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" : { "stpMode" : 1, "mstpRegions" : [ { "regionId" : "fbb684c8-0d37-496f-bafa-4b06e5151e2e", "regionName" : "stp_region", "revisionLevel" : 0, "mstpRegionInstances" : [ { "instanceId" : 0, "mapVlan" : "1,3-10", "regionInstanceDevices" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : 15 } ] } ], "regionDeviceList" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "LSW" } ] } ], "rstpConfig" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : 15 } ] } }