华为云用户手册

  • URI /controller/campus/v1/sdwan/netstream/{deviceId}/interface/ifName/applyFlexflowRecord/delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 0~36个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000"
  • 请求示例 HTTP的示例 POST /controller/campus/v1/networkconfigservice/deploy/devices/fbde1c5d-5b94-49e3-a912-48641015e45c/redeploy 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
  • 响应示例 返回状态码为200:失败重新下发成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 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的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-if/GE0%2F0%2F2 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-dhcpv4:dhcpv4-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/2"
  • 响应示例 返回状态码为200:操作成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 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,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应示例 返回状态码为200:接口调用成功,响应体参考BannerSiteResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "applySite" : ["be6e6d19-815a-4959-93ea-0e369ce3be0f"] } 返回状态码为400:Invalid tag value HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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/v2/banner/banner/be6e6d19-815a-4959-93ea-0e369ce3be0f/sites 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
  • 请求示例 HTTP的示例 POST /controller/campus/api/v1/devices/lldp/scan/task 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 { "devices" : [ "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" ] }
  • 响应示例 返回状态码为200:创建LLDP发现任务响应成功,响应体参考CreateLldpTaskResp。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "taskId" : "ee4d21b7-27cf-4b2e-af7a-8231a31152c0", "devices" : [ "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" ] } 返回状态码为400:接口参数校验异常,无响应体。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应示例 返回状态码为200:查询成功,响应体参考PingTaskResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errorCode" : 0, "errorMsg" : "", "data" : [ { "taskId" : "00000000-0000-0000-0000-000000000000", "taskName" : "task", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device", "networkType" : 0, "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link", "virtualNetworkId" : "00000000-0000-0000-0000-000000000000", "virtualNetworkName" : "vpn1", "vpnName" : "vpn", "ipType" : "IPv4", "sourceIp" : "192.168.1.1", "target" : "192.168.1.1", "packetSize" : 100, "parketNumber" : 10, "status" : 1, "packetLossRate" : 20, "avgDelay" : 20 } ] } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 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/v2/sdwan/diagnose/ping/task/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
  • 响应参数 返回状态码为200:查询成功,响应体参考PingTaskResponse。 表2 PingTaskResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 错误码。 0 errorMsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2147483647个列表项,详细请参见表3。 - - 表3 PingTaskInfoOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 taskId string - - 任务ID,创建ping任务时自动生成。 "00000000-0000-0000-0000-000000000000" taskName string - - 任务名称。 "task" siteId string - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "site" deviceId string - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "device" networkType Int2 - 0 网络类型:0 表示物理网络,1 表示虚拟网络。默认值0(物理网络)。 0 linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" linkName string - - 链路名称。 "link" virtualNetworkId string - - 虚拟网络ID。 "00000000-0000-0000-0000-000000000000" virtualNetworkName string - - 虚拟网络实例名称。 "vpn1" vpnName string - - 虚拟网络名称。 "vpn" ipType string - - IP类型,值为IPv4或者IPv6。 "IPv4" sourceIp string - - 源IP。 "192.168.1.1" target string - - 目的IP。 "192.168.1.1" packetSize Int4 - 56 包大小。默认值56。 100 parketNumber Int2 - 5 请求包个数。默认值5。 10 status Int2 - - 任务状态。0表示成功,1表示进行中,2表示超时。 1 packetLossRate int4 - - 丢包率(%)。 20 avgDelay int8 - - 平均时延(ms)。 20 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 post /controller/campus/api/v1/terminal/scanrule HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "id": "f0039bfc-5cf0-1f24-2865-86016a8a83c0", "name": "scanRule", "description": "scanRule", "scanType": [ "Real-time","Periodic" ], "scanPeriod": 30, "scanRangeList": [ { "id": "e555c570-2247-a16e-03e4-033e142474da", "sourceIp": "xxx", "vlanId": 1234, "scanIp": "xxx", "mask": 24, "description": "scanRange" } ], "vendors": [ "huawei","hikvision","dahua","uniview","tplink" ], "categories": "ip-camera" }
  • 响应参数 返回状态码为200:更新成功,响应体参考TerminalScanResponse。 TerminalScanResponse对象的参数列表,详细请参见表4。 返回状态码为400:接口调用失败,响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表,详细请参见表7。 返回状态码为500:内部错误,响应体参考CommonErrorDto。 CommonErrorDto对象的参数列表,详细请参见表7。
  • 响应示例 返回状态码为200:更新成功,响应体参考TerminalScanResponse。 HTTPS 200 OK Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "data": { "id": "f0039bfc-5cf0-1f24-2865-86016a8a83c0", "name": "scanRule", "description": "scanRule", "scanType": [ "Real-time","Periodic" ], "scanPeriod": 30, "scanRangeList": [ { "id": "e555c570-2247-a16e-03e4-033e142474da", "sourceIp": "xxx", "vlanId": 1234, "scanIp": "xxx", "mask": 24, "description": "scanRange" } ], "vendors": [ "huawei","hikvision","dahua","uniview","tplink" ], "categories": "ip-camera" } } 返回状态码为400:接口调用失败,响应体参考CommonErrorDto。 HTTPS 400 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80014", "errmsg":"data not exist", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" } 返回状态码为500:内部错误,响应体参考CommonErrorDto。 HTTPS 500 ERROR Date: Jan,13 Fri 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0x00c80018", "errmsg":"internal error", "errdesc": "", "errreason": "", "errdetail": "", "erradvice": "" }
  • 请求示例 HTTP的示例 PUT /controller/campus/v3/networkconfig/timetemplate HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "id": "94386ba0-9976-4f92-b699-f3ca00de56e5", "templateName": "tem01", "dayContentDtoList": [{ "switchDay": 1, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 2, "startTime": "08:30", "endTime": "20:30", "onOff": true }, { "switchDay": 3, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 4, "startTime": "08:30", "endTime": "20:30", "onOff": true }, { "switchDay": 5, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 6, "startTime": "09:00", "endTime": "17:00", "onOff": true }, { "switchDay": 7, "startTime": "08:00", "endTime": "18:00", "onOff": true }] }
  • 响应示例 返回状态码为200:修改时间段模板结果。 HTTP/1.1 200 OK Date: Thu,13 Sep 2018 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "data": { "id": "94386ba0-9976-4f92-b699-f3ca00de56e5", "templateName": "tem01", "dayContentDtoList": [{ "switchDay": 1, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 2, "startTime": "08:30", "endTime": "20:30", "onOff": true }, { "switchDay": 3, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 4, "startTime": "08:30", "endTime": "20:30", "onOff": true }, { "switchDay": 5, "startTime": "08:00", "endTime": "18:00", "onOff": true }, { "switchDay": 6, "startTime": "09:00", "endTime": "17:00", "onOff": true }, { "switchDay": 7, "startTime": "08:00", "endTime": "18:00", "onOff": true }] } } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 modifyDto 是 REFERENCE 详细请参见表2。 修改时间段模板入参。 - 表2 TimeTemplateDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templateName 是 string 1~32个字符。 - 模板名称。 "eee" dayContentDtoList 是 ARRAY_REFERENCE 7个列表项,详细请参见表3。 时间段列表,列表必须分别为周一至周日7天时间段数据。 - id 是 string 36个字符。 - 模板标识,UUID格式。 "d8b568f4-9918-4c09-a49f-c35e3bf7086b"
  • 响应示例 返回状态码为201:创建的防火墙设备NAT配置。 HTTP/1.1 201 Created Date: Sun,16 Feb 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" : { "name" : "nat1", "description" : "", "conversionMode" : 3, "destinationMode" : "address-to-address", "sourceZones" : [ "00000000-0000-0000-0000-000000000001" ], "destinationZones" : [ "00000000-0000-0000-0000-000000000003" ], "oldSourceIp" : "10.2.0.6/24", "oldDestinationIp" : "10.1.1.10", "sourceConvert" : 1, "newSourceIpGroup" : [ "10.1.1.10" ], "newDestinationIpGroup" : [ "10.1.1.10" ], "destinationPort" : "80,82-98", "serviceList" : [ { "serviceType" : "tcp", "sourcePort" : "80", "destPort" : "80-97" } ], "id" : "de5813f8ff1e41f5ba9c324da70b49ed", "priority" : 5 } } 返回状态码为400:校验失败信息。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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/fwnat/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/fwnat 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" : "nat1", "description" : "", "conversionMode" : 3, "destinationMode" : "address-to-address", "sourceZones" : [ "00000000-0000-0000-0000-000000000001" ], "destinationZones" : [ "00000000-0000-0000-0000-000000000003" ], "oldSourceIp" : "10.2.0.6/24", "oldDestinationIp" : "10.1.1.10", "sourceConvert" : 1, "newSourceIpGroup" : [ "10.1.1.10" ], "newDestinationIpGroup" : [ "10.1.1.10" ], "destinationPort" : "80,82-98", "serviceList" : [ { "serviceType" : "tcp", "sourcePort" : "80", "destPort" : "80-97" } ] }
  • URI /controller/campus/v1/networkservice/networkconfig/net/fwnat/devices/{deviceId}/fwnat 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备标识,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 待更新的ACL模板信息。 - 表3 UpdateAclDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~32个字符。 - ACL模板名称,包括汉字、字母、数字、下划线、.、@、-不能与已有的名称重复。 "ACLTemplate1" description 否 string 0~127个字符。 - ACL模板描述。 "ACLTemplate1" ruleList 否 ARRAY_REFERENCE 1-1024个列表项,详细请参见表3。 规则列表。 - aclNumber 否 string - - ACL模板编号,必须为数字,aclType为Advanced时,aclNumber范围:3001-3999,aclType为User时,aclNumber范围:6000-6031。 "3001"
  • 请求示例 HTTP的示例 PUT /controller/campus/v3/profile/acl/fbde1c5d-5b94-49e3-a912-48641015e45c 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" : "ACLTemplate1", "description" : "ACLTemplate1", "ruleList" : [ { "ruleId" : "1", "ip" : "", "domain" : "", "policy" : "permit", "protocol" : "tcp", "tcpFlag" : "ack,fin", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "dscp" : 2, "description" : "Rule1" } ], "aclNumber" : "3001" }
  • 响应示例 返回状态码为200:成功更新的ACL模板信息。 HTTP/1.1 200 OK Date: Sun,16 Feb 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-48641015e45c", "name" : "ACLTemplate1", "aclNumber" : "3001", "description" : "ACLTemplate1", "aclType" : "Advanced", "ruleList" : [ { "ruleId" : "1", "ip" : "", "domain" : "", "policy" : "permit", "protocol" : "tcp", "tcpFlag" : "ack,fin", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "dscp" : 2, "description" : "Rule1" } ], "ipType" : "ipv4" } } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应示例 返回状态码为200:调用创建堆叠成功,响应体参考CreateStackOutDto。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : [ { "stackId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca", "stackName" : "stack1", "stackMember" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca", "esn" : "AP5008293500000001", "stackMemberId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359xa", "slotId" : 0, "priority" : 100 } ] } ], "fail" : [ { "stackName" : "site1", "stackMember" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca", "esn" : "AP5008293500000001", "stackMemberId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359xa", "slotId" : 0, "priority" : 100 } ] } ] }
  • 响应参数 返回状态码为200:调用创建堆叠成功,响应体参考CreateStackOutDto。 表5 CreateStackOutDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。当没有错误时返回0。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 成功的堆叠设备列表。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表8。 失败的堆叠设备列表。 - 表6 createStackSuccess对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 stackId string 1~64个字符。 - 堆叠ID,UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" stackName string 1~64个字符。 - 堆叠名称。 该字段对应UI页面上是:UI【堆叠名称】 "stack1" stackMember ARRAY_REFERENCE 1-9个列表项,详细请参见表7。 堆叠成员。 - 表7 StackMemberOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" deviceId string - - 设备ID,UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" esn string - - 设备ESN。 该字段对应UI页面上是:UI【ESN】 "AP5008293500000001" stackMemberId string - - 堆叠成员ID,UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359xa" slotId int32 - - 设备堆叠编号。 该字段对应UI页面上是:UI【槽位号】 0 priority int32 - - 设备堆叠优先级。 该字段对应UI页面上是:UI【优先级】 100 表8 createStackFail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 stackName string 1~64个字符。 - 堆叠名称。 该字段对应UI页面上是:UI【堆叠名称】 "site1" stackMember ARRAY_REFERENCE 1-9个列表项,详细请参见表7。 堆叠成员 -
  • 请求示例 HTTP的示例 POST /controller/campus/v3/stack 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 { "stacks" : [ { "stackName" : "stack1", "stackMember" : [ { "esn" : "AP5008293500000001", "slotId" : 0, "priority" : 100 } ], "stackRoles" : "ACC" } ] }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 createStackDto 是 REFERENCE 详细请参见表2。 创建堆叠入参。 - 表2 CreateStackDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 stacks 是 ARRAY_REFERENCE 0-100个列表项,详细请参见表3。 堆叠信息。 - 表3 CreateStackDtoData对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 stackName 是 string 1~64个字符。 - 堆叠名称。如果堆叠名称已存在,则将设备加入堆叠;否则,创建堆叠并加入设备。堆叠名称不能包含"?"或者制表符TAB。 该字段对应UI页面上是:UI【堆叠名称】 "stack1" stackMember 是 ARRAY_REFERENCE 1-9个列表项,详细请参见表4。 堆叠成员。 - stackRoles 否 string Gateway CORE Gateway+CORE Gateway+RR Firewall WAC AGG ACC Wireless Access TG ACC 堆叠角色信息。非必填,默认为ACC。 该字段对应UI页面上是:UI【堆叠角色】 "ACC" 表4 StackMemberInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 esn 是 string 10~64个字符。 - 设备ESN。 该字段对应UI页面上是:UI【ESN】 "AP5008293500000001" slotId 否 int32 [0-9] - 堆叠成员编号。(添加盒式堆叠成员时非必填,添加框式堆叠成员时必填)。 该字段对应UI页面上是:UI【槽位号】 0 priority 否 int32 [1-255] 100 堆叠成员优先级。 该字段对应UI页面上是:UI【优先级】 100
  • 响应示例 返回状态码为200:删除文件返回结果。响应体参考DeleteFileResponse HTTP/1.1 200 OK Date: Sun,16 Feb 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" : [ { "fileName" : "test.xml", "fileId" : "" } ], "failList" : [ { "fileName" : "", "errCode" : "0", "errMsg" : "" } ] } 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
共99354条