华为云用户手册

响应示例 返回状态码为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的示例 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-AC CES S-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" }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/lswstp/sites/fbb684c8-0d37-496f-bafa-4b06db151e2e/stp-increment 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 { "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" : [ "" ] } ] }

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

请求示例 HTTP的示例 POST /controller/campus/v1/authconfigservice/accessconfig/fbb684c8-0d37-496f-bafa-4b06d5151e2e/ppsk/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 { "ppskIdList" : ["00000000000000000000000000000000"] }

URI /controller/campus/v1/authconfigservice/accessconfig/{siteId}/ppsk/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 32~40个字符。 - 站点ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为200：删除成功，响应体参考BatchDeletePpskResponseDto。 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 { "errmsg" : "", "errcode" : "", "successList" : ["00000000000000000000000000000000"], "failList" : [ { "errmsg" : "", "errcode" : "0", "ppskId" : "00000000000000000000000000000000" } ] } 返回状态码为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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 租户下设备admin/accampus账号的密码配置信息，结构体参见initLocalUserInfoRequst。 - 表2 initLocalUserInfoRequst对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 password 是 password 8~128个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 1、密码长度必须在8-128位。(防火墙设备的密码最大长度为64，如果租户内存在防火墙，请输入64位以内字符)2、密码必须满足复杂度，即至少包含英文大写字母（A~Z）、英文小写字母（a~z）、数字（0~9）、特殊字符（如！、@、#、$、%）等中的三种，不允许包含'、?和空格。3、密码中不能包含两个以上连续的相同字符。4、密码不能为用户名或用户名的倒写。 "Iam@example" operationRange 否 string - new 操作对象范围(仅新建站点'new', 全部站点'all', 任务失败的站点'failed')，默认值为new。 "new"

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/localuser/users/admin 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", "operationRange" : "new" }

响应示例 返回状态码为200：修改成功，返回信息，结构体参见initLocalUserInfoResponse。 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" : "" }

响应示例 返回状态码为200：查询成功，响应体参考BatchQueryDeviceCertificateResponseDto。 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" : "00000000-0000-0000-0000-000000000000", "deviceEsn" : "esn", "certificationStatus" : "0", "issuer" : "Huawei Equipment CA", "issuerDatetime" : 1557187200000, "expirationDatetime" : 1558656000000, "failureReason" : "在线更新设备证书失败" } ] } 返回状态码为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：查询成功，响应体参考BatchQueryDeviceCertificateResponseDto。 表3 BatchQueryDeviceCertificateResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~64个字符。 - 错误码。 "0" errmsg string 0~64个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 结果返回列表 - 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/certification/device/certificate/batch-query 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 { "deviceIds" : [ "57f879c7-7f6a-4d3a-88af-bf2585cb61e0" ] }

请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/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 { "vpnId" : "310473a6-8006-48a3-9558-543d32ea1757", "templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteIds" : ["00000000-0000-0000-0000-000000000000"] }

响应示例 返回状态码为201：接口调用成功，响应体参考OverlayWanBgpPolicyTemplateBindSiteResponse。 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" : "00000000-0000-0000-0000-000000000000" } 返回状态码为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/networkservice/networkconfig/net/lswstaticmac/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/staticmac?pageIndex=1&pageSize=20 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/networkservice/networkconfig/net/lswstaticmac/devices/{deviceId}/staticmac 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 integer [1-1024] - 页面索引，支持静态mac地址列表分页。 1 pageSize 是 integer [1-1000] - 每页显示记录数，支持静态mac地址列表分页。 20

响应示例 返回状态码为200：查询成功，返回设备所有MAC静态绑定信息。 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 { "interfaceNameList" : ["GigabitEthernet0/0/1","GigabitEthernet0/0/2"], "staticMacList" : [ { "macAddress" : "XX:XX:XX:XX:XX:XX", "vlanId" : 1, "interfaceName" : "GigabitEthernet0/0/1", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" } ], "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 10, "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

响应示例 返回状态码为200：强制下线返回结果，响应体参考MobileTerminalOfflineResponse。 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" : ["460030912121001"], "failList" : [ { "errcode" : "0x022b0006", "errmsg" : "no rights", "imei" : "990000862471854", "imsi" : "990000862471854" } ] } 返回状态码为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/accountservice/terminalmgr/mobile/offline 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 { "imeis" : ["460030912121001"] }

请求示例 HTTP的示例 GET /controller/campus/api/v1/networkconfig/lswdefendpolicy/devices/fbb684c8-0d37-496f-bafa-4b06d6151e2e/defendpolicy 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