华为云用户手册

响应示例 返回状态码为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-mpls-if:mpls-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个字符。 - 接口名称，单一主键字段。 "GE0/0/1"

请求示例 HTTP的示例 PUT /controller/campus/v2/accountservice/accessuser/users/usergroup 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 { "destGroupId" : "b88b0334-4d81-477d-b4f6-4705ecfcae90", "userIds" : [ "35da2f2e-f29d-4ae2-b81e-0142a309f6da" ] }

响应示例 返回状态码为200：转移成功，响应体参考TransformUserGroupOutputDto。 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" : ["35da2f2e-f29d-4ae2-b81e-0142a309f6de"], "failList" : [ { "errcode" : "0308000221", "errmsg" : "The selected user does not exist", "userId" : "25da2f2e-f29d-4ae2-b81e-0142a309f6de" } ] } 返回状态码为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：查询成功，响应体参考GetFanInfoOutputDto。 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" : [ { "id" : "1/FAN1", "onlineState" : "0", "registerState" : "0", "runningState" : "0", "speed" : 49, "mode" : "0", "airFlow" : "Back-to-Side" } ] } 返回状态码为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/oamservice/faninfo/devices/{id}/frame/{frameNo} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string - - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" frameNo 是 integer 1 2 - 机框号。 1

请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/faninfo/devices/00000000-0000-0000-0000-000000000000/frame/1 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：查询成功，响应体参考GetFanInfoOutputDto。 表2 GetFanInfoOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "error" data ARRAY_REFERENCE 0-4个列表项，详细请参见表3。 查询风扇信息结果。 - 表3 FanInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~32个字符。 - 风扇ID。 "1/FAN1" onlineState string 0~64个字符。 - 风扇在线状态。取值范围：0（代表present在位），1（代表absent不在位）。 "0" registerState string 0~64个字符。 - 风扇注册状态。取值范围：0（代表unregisted未注册），1（代表registed已注册）。 "0" runningState string 0~64个字符。 - 风扇运行状态 。取值范围：0（代表unknown未知），1（代表normal正常），2（代表abnormal不正常）。 "0" speed integer - - 风扇转速，转速与全速的百分比，取值范围1-100。 49 mode string 0~64个字符。 - 风扇模式，取值范围：1（代表AUTO：自动调节转速）；2（代表MANUAL：固定转速）；0（代表UNKNOW：风扇不在位）。 "0" airFlow string 0~32个字符。 - 风扇的风向，取值范围：Back-to-Side（表示风由后面向两侧吹）；Side-to-Back（表示风由两侧向后面吹）；Side-to-Side（表示风由一侧往另外一侧吹）；-（风扇不在位）。 "Back-to-Side" 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /v1/accountservice/cert-manager/crls/action/batch-immediate-sync 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 { "{ \n \"ids\":[ \"db27dbc7-a962-4e8a-b23d-bc5e9e3a6881\" ]\n }" }

响应示例 返回状态码为200：设置认证源信息返回体, 同步操作为异步操作,结果需要通过查询list来获取同步结果 { "errcode": "0", "errmsg": " ", "successList": [ "db27dbc7-a962-4e8a-b23d-bc5e9e3a6881" ], "failList": [] } 返回状态码为207：设置认证源信息返回体, 同步操作为异步操作,结果需要通过查询list来获取同步结果,部分证书同步成功 { "errcode": "0", "errmsg": " ", "successList": [ "db27dbc7-a962-4e8a-b23d-bc5e9e3a6881" ], "failList": [ { "errcode": "0x00c8005a", "errmsg": "No rights.", "id": "db27dbc7-a962-4e8a-b23d-bc5e9e3a6333" } ] } 返回状态码为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的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-vpn:vpn/vpn1 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"

响应示例 返回状态码为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-vpn:vpn" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "instance-name" : "vpn1", "af" : [ { "type" : "ipv4-unicast", "route-distinguisher" : "1:1", "vpn-target" : [ { "value" : "1:1", "vpn-target-type" : "export-extcommunity" } ], "import-policy" : "policy1", "export-policy" : "policy2" } ] } ] } 返回状态码为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-vpn:vpn/{instance-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" instance-name 是 string 1~31个字符。 - VPN实例名，单一主键字段。 "vpn1"

响应示例 返回状态码为200：查询成功，响应体参考InterfacesInfoOutputDto。 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 { "interfaceInfoList" : [ { "interfaceId" : "bb95ad5c-cdf5-46f2-9f1c-0d413320adb7", "ifIndex" : 1, "ifName" : "GigabitEthernet1/1/0/14", "deviceId" : "bb95ad5c-cdf5-46f2-9f1c-0d413320adb7", "ifOperStatus" : "UP", "ifAdminStatus" : "UP", "ipAddress" : "10.1.1.1", "ifSpeeds" : "100", "ifMtu" : "100", "ifDuplexModel" : "FULL", "ifType" : "ETHERNET" } ] } 返回状态码为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/interface/devices/ea25fdbf-8dee-4823-bac2-5bfe8e3359cad/frame/1/slot/1 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：查询成功，响应体参考InterfacesInfoOutputDto。 表2 InterfacesInfoOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceInfoList ARRAY_REFERENCE 0-64个列表项，详细请参见表3。 接口信息列表。 - 表3 InterfaceInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceId string 0~256个字符。 - 接口ID，UUID格式。 "bb95ad5c-cdf5-46f2-9f1c-0d413320adb7" ifIndex integer [0-64] - 接口索引。 1 ifName string 0~256个字符。 - 接口名称。 "GigabitEthernet1/1/0/14" deviceId string 0~256个字符。 - 设备ID，UUID格式。 "bb95ad5c-cdf5-46f2-9f1c-0d413320adb7" ifOperStatus string 0~256个字符。 UP DOWN TESTING UNKOWN DORMANT NOTPRESENT LOWLAYERDOWN - 接口运行态。 "UP" ifAdminStatus string 0~256个字符。 UP DOWN - 接口管理态。 "UP" ipAddress string 0~256个字符。 - 接口IP地址。 "10.1.1.1" ifSpeeds string 0~256个字符。 - 接口速率，单位是bps。 "100" ifMtu string 0~256个字符。 - 接口mtu，单位是Bytes。 "100" ifDuplexModel string 0~256个字符。 FULL HALF AUTO AUTOFULL AUTOHALF - 双工模式。 "FULL" ifType string 0~256个字符。 STACK-PORT ETHERNET ETH-TRUNK VIRTUAL_ETHERNET ATM POS SERIAL VLANIF E1 T1 CPOS TUNNEL LOOPBACK IP-TRUNK VIRTUAL-TEMPLATE RING-IF MFR MP-GROUP AUX E3 T3 METH NULL IRPR EPON WLAN-ESS RSERVED1 WLAN-DBSS WLAN-MESH VBDIF NVE - 接口类型。 "ETHERNET" 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/oamservice/interface/devices/{deviceId}/frame/{frameNo}/slot/{slotNo} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID或堆叠ID， UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359cad" frameNo 是 integer 1 2 - 机框号。 1 slotNo 是 integer [0-64] - 单板索引号，槽位号。 1

响应参数 返回状态码为200：删除成功的返回值。 表3 CommonResponseBody对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为400：参数错误，取消升级失败。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/upgrade/policy/device/cancel 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" ] }

响应示例 返回状态码为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" : "" } 返回状态码为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 { "errcode" : "0", "errmsg" : "Success", "data" : [ { "id" : "512", "name" : "指定流名称", "profileId" : "9a157da3-9e59-41c9-8312-254a38a3b275", "profileName" : "识别流模板名称", "enable" : true, "dscp" : 63 } ] } 返回状态码为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 /v1/performanceservice/flow/instances?keyword=流名称 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：随流检测基本配置查询成功后的状态返回码。 表2 FlowInfoOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "Success" data ARRAY_REFERENCE 0-512个列表项，详细请参见表3。 指定流 - 表3 FlowBaseInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~5个字符。 - 流id "512" name string 1~256个字符。 - 指定流名称 "指定流名称" profileId string 1~36个字符。 - 识别流模板ID "9a157da3-9e59-41c9-8312-254a38a3b275" profileName string 0~256个字符。 - 识别流模板名称 "识别流模板名称" enable boolean true false true 启用状态 true dscp int32 [0-63] - 静态流排序号 63 返回状态码为400：接口更新失败后的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/net/transport-network-ports/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 { "multipleSubIfEnabled" : false, "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "enhancedMode" : false, "enableNtpAutoClient" : false, "tnps" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "Link1", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "portId" : "00000000-0000-0000-0000-000000000000", "portType" : 1, "portNum" : "0/0/1", "enable5G" : "", "inSubInterface" : false, "vlanId" : 1, "subInterfaceNumber" : 1, "tnplinkInfo" : { "cellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "standbyCellularEnable" : false, "standbyCellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "simSwitchBackEnable" : false, "simSwitchBackTime" : 60, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 } }, "ipConnection" : { "ipv4" : { "publicIP" : "192.168.1.1", "accessType" : "PPPoE", "ipMode" : "Static", "customerAddress" : "192.168.1.1", "prefixLength" : 24, "providerAddress" : "192.168.1.1", "peerIp" : "192.168.1.1", "userName" : "admin", "userKey" : "******", "authType" : 0, "dlci" : 55, "interfaceMode" : 0 }, "ipv6" : { "accessType" : "IPoE", "ipMode" : "Static", "customerIPv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "providerIpv6Address" : "fc00:3::1", "linkIpv6Pd" : "sdwanprefix", "linkIpv6PdAddr" : "fc00:3::1/64", "linkDhcpv6Option16Type" : "ascii", "linkDhcpv6Option16" : "101068,0001", "linkDhcpv6Pd" : "sdwanprefix", "enableIPv6AcSouthAccess" : true, "ipv6AcSouthAccessId" : "00000000-0000-0000-0000-000000000003", "ipv6MailUsedSouthAccess" : false, "ipv6AccessPreference" : "low" } }, "transportNetworkInfo" : { "transportNetworkId" : "00000000-0000-0000-0000-000000000000", "workMode" : "active", "sendAlarmEnabled" : false }, "ntp" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 10 } ], "attributes" : { "inputBandwidth" : 1000, "outputBandwidth" : 1000, "mtu" : 1500, "TCPmss" : 1200, "ipv6Mtu" : 1500 }, "description" : "site tnp", "natEnable" : false, "ztpMode" : 0, "ipv6ZtpMode" : 0, "underlayVrf" : "underlay_1", "routingDistinguisher" : "1111:1111", "clearDeviceConfig" : true, "enableOverlay" : true, "enableIpv6Overlay" : false, "acSouthAccessId" : "00000000-0000-0000-0000-000000000001", "mailUsedSouthAccess" : false, "linkInformation" : "link1", "accessPreference" : "low", "enableSecondSouthAccess" : false, "secondSouthAccess" : { "acSouthAccessId" : "00000000-0000-0000-0000-000000000002", "accessPreference" : "low" }, "syncModifyDeviceUrlConfig" : false, "enableLoopbackSrcInterface" : false, "enableRu" : false, "disableDefaultRuRoute" : false } ] }

响应示例 返回状态码为200：正常响应返回体，返回的TNP信息中仅包含对应的ID，响应体参考TnpResponse。 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" : "Link1", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "portId" : "00000000-0000-0000-0000-000000000000", "portType" : 1, "portNum" : "0/0/1", "enable5G" : "", "inSubInterface" : false, "vlanId" : 1, "subInterfaceNumber" : 1, "tnplinkInfo" : { "cellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "standbyCellularEnable" : false, "standbyCellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "simSwitchBackEnable" : false, "simSwitchBackTime" : 60, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 } }, "ipConnection" : { "ipv4" : { "publicIP" : "192.168.1.1", "accessType" : "PPPoE", "ipMode" : "Static", "customerAddress" : "192.168.1.1", "prefixLength" : 24, "providerAddress" : "192.168.1.1", "peerIp" : "192.168.1.1", "userName" : "admin", "userKey" : "******", "authType" : 0, "dlci" : 55, "interfaceMode" : 0 }, "ipv6" : { "accessType" : "IPoE", "ipMode" : "Static", "customerIPv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "providerIpv6Address" : "fc00:3::1", "linkIpv6Pd" : "sdwanprefix", "linkIpv6PdAddr" : "fc00:3::1/64", "linkDhcpv6Option16Type" : "ascii", "linkDhcpv6Option16" : "101068,0001", "linkDhcpv6Pd" : "sdwanprefix", "enableIPv6AcSouthAccess" : true, "ipv6AcSouthAccessId" : "00000000-0000-0000-0000-000000000003", "ipv6MailUsedSouthAccess" : false, "ipv6AccessPreference" : "low" } }, "transportNetworkInfo" : { "transportNetworkId" : "00000000-0000-0000-0000-000000000000", "workMode" : "active", "sendAlarmEnabled" : false }, "ntp" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 10 } ], "attributes" : { "inputBandwidth" : 1000, "outputBandwidth" : 1000, "mtu" : 1500, "TCPmss" : 1200, "ipv6Mtu" : 1500 }, "description" : "site tnp", "natEnable" : false, "ztpMode" : 0, "ipv6ZtpMode" : 0, "underlayVrf" : "underlay_1", "routingDistinguisher" : "1111:1111", "clearDeviceConfig" : true, "enableOverlay" : true, "enableIpv6Overlay" : false, "acSouthAccessId" : "00000000-0000-0000-0000-000000000001", "mailUsedSouthAccess" : false, "linkInformation" : "link1", "accessPreference" : "low", "enableSecondSouthAccess" : false, "secondSouthAccess" : { "acSouthAccessId" : "00000000-0000-0000-0000-000000000002", "accessPreference" : "low" }, "syncModifyDeviceUrlConfig" : false, "enableLoopbackSrcInterface" : false, "enableRu" : false, "disableDefaultRuRoute" : false } ], "fail" : [ { "errcode" : "error", "errmsg" : "error message", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "Link1", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "portId" : "00000000-0000-0000-0000-000000000000", "portType" : 1, "portNum" : "0/0/1", "enable5G" : "", "inSubInterface" : false, "vlanId" : 1, "subInterfaceNumber" : 1, "tnplinkInfo" : { "cellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "standbyCellularEnable" : false, "standbyCellular" : { "apn" : "abc", "userName" : "user1", "userKey" : "******", "authType" : 0, "priority" : 100, "trackEnable" : false, "nqaInfo" : { "destAddress" : "192.168.1.1" } }, "simSwitchBackEnable" : false, "simSwitchBackTime" : 60, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 } }, "ipConnection" : { "ipv4" : { "publicIP" : "192.168.1.1", "accessType" : "PPPoE", "ipMode" : "Static", "customerAddress" : "192.168.1.1", "prefixLength" : 24, "providerAddress" : "192.168.1.1", "peerIp" : "192.168.1.1", "userName" : "admin", "userKey" : "******", "authType" : 0, "dlci" : 55, "interfaceMode" : 0 }, "ipv6" : { "accessType" : "IPoE", "ipMode" : "Static", "customerIPv6Address" : "fc00:3::1", "ipv6PrefixLength" : 64, "providerIpv6Address" : "fc00:3::1", "linkIpv6Pd" : "sdwanprefix", "linkIpv6PdAddr" : "fc00:3::1/64", "linkDhcpv6Option16Type" : "ascii", "linkDhcpv6Option16" : "101068,0001", "linkDhcpv6Pd" : "sdwanprefix", "enableIPv6AcSouthAccess" : true, "ipv6AcSouthAccessId" : "00000000-0000-0000-0000-000000000003", "ipv6MailUsedSouthAccess" : false, "ipv6AccessPreference" : "low" } }, "transportNetworkInfo" : { "transportNetworkId" : "00000000-0000-0000-0000-000000000000", "workMode" : "active", "sendAlarmEnabled" : false }, "ntp" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 10 } ], "attributes" : { "inputBandwidth" : 1000, "outputBandwidth" : 1000, "mtu" : 1500, "TCPmss" : 1200, "ipv6Mtu" : 1500 }, "description" : "site tnp", "natEnable" : false, "ztpMode" : 0, "ipv6ZtpMode" : 0, "underlayVrf" : "underlay_1", "routingDistinguisher" : "1111:1111", "clearDeviceConfig" : true, "enableOverlay" : true, "enableIpv6Overlay" : false, "acSouthAccessId" : "00000000-0000-0000-0000-000000000001", "mailUsedSouthAccess" : false, "linkInformation" : "link1", "accessPreference" : "low", "enableSecondSouthAccess" : false, "secondSouthAccess" : { "acSouthAccessId" : "00000000-0000-0000-0000-000000000002", "accessPreference" : "low" }, "syncModifyDeviceUrlConfig" : false, "enableLoopbackSrcInterface" : false, "enableRu" : false, "disableDefaultRuRoute" : false } } ] } 返回状态码为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：删除成功，响应体参考TagRes。 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" : "" }

请求示例 HTTP的示例 POST /controller/campus/baseservice/api/v1/devicemgr/tags/action/unbind-devices 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 { "tagNames" : ["tag1","tag2"], "deviceIds" : ["d25de9be-1d9a-4d06-a519-09ff92fee050","d25de9be-1d9a-4d06-a519-09ff92fee050"] }

请求示例 HTTP的示例 GET /controller/campus/baseservice/api/v1/filemgr/files?pageIndex=1&pageSize=20&sort=+fileName&filter=fileType::20|keyword::test|feature::1|status::1 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：文件查询成功返回，响应体参考QueryFileResponse 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" : "", "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 1, "fileInfoList" : [ { "fileId" : "7d4ea473-dc8b-4acc-8cf9-0a550cbb09e6", "subFileDetails" : [ { "fileId" : "7d4ea473-dc8b-4acc-8cf9-0a550cbb09e6", "subFileDetails" : [ { ... } ], "currentUserUpload" : true, "fileType" : 20, "feature" : 22, "version" : "1.1", "fileName" : "test.xml", "description" : "文件描述", "tenantName" : "tenant", "fileSize" : "0", "offset" : 0, "sizeUnit" : "B", "uploadProgress" : 100, "createTime" : "2022-10-25 21:01:35", "iconString" : null, "storageTypesSupport" : [ { ... } ], "fileServerName" : " FusionInsight ", "manualRecord" : 0, "status" : 1, "needToReboot" : false, } ], "currentUserUpload" : true, "fileType" : 20, "feature" : 22, "version" : "1.1", "fileName" : "test.xml", "description" : "文件描述", "tenantName" : "tenant", "fileSize" : "0", "offset" : 0, "sizeUnit" : "B", "uploadProgress" : 100, "createTime" : "2022-10-25 21:01:35", "iconString" : "", "storageTypesSupport" : [ "" ], "fileServerName" : "FusionInsight", "manualRecord" : 0, "status" : 1, "needToReboot" : 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

URI /controller/campus/baseservice/api/v1/filemgr/files 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-2147483647] - 当前页码。默认为1 1 pageSize 否 int32 [0-1000] - 分页大小。默认为20 20 sort 否 string 0~100个字符。 - sort: 排序方式。默认文件名排序 可根据： displayName、uploadProgress、type tenantName、status、size、createTime 的文件信息字段进行排序， 传参字段前+为正序-为倒序 "+fileName" filter 是 string 0~255个字符。 - 查询过滤条件 filter支持字段: | fileType（必填） | 查询的文件类型 | | :----- | :----- | | 25 | CPE软件包 | | 22 | 插件 | | 20 | 设备license | | 1 | 镜像包 | | keyword | 关键字 | | :----- | :----- | | 匹配范围 | 文件名、版本、描述、租户名| | feature | 查询的插件类型| | :----- | :----- | | 0 | wireless | | 1 | IOT | | status | 查询的插件状态，只有传feature参数时生效 | | :----- | :----- | | 1 | 解析完成 | filter格式控制 参数名::参数值 分隔符| "fileType::20|keyword::test|feature::1|status::1"