华为云用户手册

  • 响应示例 返回状态码为201:创建成功,响应体参考TacacsServerTemplateResponse。 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" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "templateName" : "server1", "descr" : "server1 is in SD", "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "primaryAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "isContainDomainName" : true, "passwordKey" : "Example@123", "sourceIp" : "10.134.6.5", "tempalteId" : "" } } 返回状态码为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:创建成功,响应体参考TacacsServerTemplateResponse。 表4 TacacsServerTemplateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表5。 TACA CS 创建消息响应 - 表5 TacacsCreateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" templateName string 1~32个字符。 - 模板名称,区分大小写。名称中只能包含英文字母、数字(0到9)、点号(.)、下划线(_)、中划线(-)以及上述字符的组合,不能配置为“-”或“--”。创建后不允许修改。 "server1" descr string 0~128个字符。 - 描述。 "server1 is in SD" primaryAuthenServerInfo REFERENCE 详细请参见表6。 主认证服务信息 - secondAuthenServerInfo REFERENCE 详细请参见表6。 备认证服务信息 - thirdAuthenServerInfo REFERENCE 详细请参见表6。 备认证服务信息 - primaryAuthorServerInfo REFERENCE 详细请参见表6。 主授权服务信息 - secondAuthorServerInfo REFERENCE 详细请参见表6。 备授权服务信息 - thirdAuthorServerInfo REFERENCE 详细请参见表6。 第三授权服务信息 - primaryAccountServerInfo REFERENCE 详细请参见表6。 主记账服务信息 - secondAccountServerInfo REFERENCE 详细请参见表6。 备记账服务信息 - thirdAccountServerInfo REFERENCE 详细请参见表6。 第三记账服务信息 - isContainDomainName boolean true false - 是否包含 域名 ,默认false。 true passwordKey password 1~255个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 共享密钥,建议长度不小于8位。 "Example@123" sourceIp string 0~64个字符。 - 设备与HWTACACS服务器通信的源IPv4地址。 若上述6个服务器信息中填写有VPNID时必填。 "10.134.6.5" tempalteId uuid - - 模板ID,UUID格式,主键字段。 - 表6 AAAServerInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 serverIP string 0~64个字符。 - 服务器IP地址,支持IPv4。 "10.134.6.5" serverPort int32 [1-65535] - 服务器端口号, 范围1~65535。 10 tnpId uuid - - 指定站点设备下用于连接ServerIp的TNP ID。 tnpId和vpnId必须且只能选一个,UUID格式。 "00000000-0000-0000-0000-000000000000" vpnId uuid - - 指定站点设备下用于连接ServerIp的VPN ID。 tnpId和vpnId必须且只能选一个,UUID格式。 "00000000-0000-0000-0000-000000000000" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/aaa/tacaservertemplate 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 { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "templateName" : "server1", "descr" : "server1 is in SD", "primaryAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAuthenServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "primaryAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAuthorServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "primaryAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "secondAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "thirdAccountServerInfo" : { "serverIP" : "10.134.6.5", "serverPort" : 10, "tnpId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000" }, "isContainDomainName" : true, "passwordKey" : "Example@123", "sourceIp" : "10.134.6.5" }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tacacsServerTemplate 是 REFERENCE 详细请参见表2。 HWTACACS服务器模板信息。 - 表2 TacacsServerTemplateInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" templateName 是 string 1~32个字符。 - 模板名称,区分大小写。名称中只能包含英文字母、数字(0到9)、点号(.)、下划线(_)、中划线(-)以及上述字符的组合,不能配置为“-”或“--”。创建后不允许修改。 "server1" descr 否 string 0~128个字符。 - 描述。 "server1 is in SD" primaryAuthenServerInfo 是 REFERENCE 详细请参见表3。 主认证服务信息 - secondAuthenServerInfo 否 REFERENCE 详细请参见表3。 备认证服务信息 - thirdAuthenServerInfo 否 REFERENCE 详细请参见表3。 备认证服务信息 - primaryAuthorServerInfo 是 REFERENCE 详细请参见表3。 主授权服务信息 - secondAuthorServerInfo 否 REFERENCE 详细请参见表3。 备授权服务信息 - thirdAuthorServerInfo 否 REFERENCE 详细请参见表3。 第三授权服务信息 - primaryAccountServerInfo 否 REFERENCE 详细请参见表3。 主记账服务信息 - secondAccountServerInfo 否 REFERENCE 详细请参见表3。 备记账服务信息 - thirdAccountServerInfo 否 REFERENCE 详细请参见表3。 第三记账服务信息 - isContainDomainName 否 boolean true false - 是否包含域名,默认false。 true passwordKey 是 password 1~255个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 共享密钥,建议长度不小于8位。 "Example@123" sourceIp 否 string 0~64个字符。 - 设备与HWTACACS服务器通信的源IPv4地址。 若上述6个服务器信息中填写有VPNID时必填。 "10.134.6.5" 表3 AAAServerInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 serverIP 是 string 0~64个字符。 - 服务器IP地址,支持IPv4。 "10.134.6.5" serverPort 是 int32 [1-65535] - 服务器端口号, 范围1~65535。 10 tnpId 否 uuid - - 指定站点设备下用于连接ServerIp的TNP ID。 tnpId和vpnId必须且只能选一个,UUID格式。 "00000000-0000-0000-0000-000000000000" vpnId 否 uuid - - 指定站点设备下用于连接ServerIp的VPN ID。 tnpId和vpnId必须且只能选一个,UUID格式。 "00000000-0000-0000-0000-000000000000"
  • 响应示例 返回状态码为200:删除站点全部成功,响应体参考BatchDeleteSiteOut。 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" : "Failed to delete the site", "success" : ["ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"], "fail" : [ { "errCode" : "0", "errMsg" : "The default site can not be deleted.", "id" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" } ] } 返回状态码为207:删除站点部分成功,响应体参考BatchDeleteSiteOut。 HTTP/1.1 207 Multi-Status 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" : "Failed to delete the site", "success" : ["ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"], "fail" : [ { "errCode" : "0", "errMsg" : "The default site can not be deleted.", "id" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" } ] } 返回状态码为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 { "errCode" : "0", "errMsg" : "Failed to delete the site", "success" : ["ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"], "fail" : [ { "errCode" : "0", "errMsg" : "The default site can not be deleted.", "id" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" } ] } 返回状态码为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/v3/sites/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 { "ids" : ["ea25fdbf-8dee-4823-bac2-5bfe8e3359ca"] }
  • 响应参数 返回状态码为200:接口调用成功,响应体参考TrafficStatisticDataResp。 表3 TrafficStatisticDataResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码信息。 "0" errmsg string 0~256个字符。 - 结果信息。 "" data ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 查询到的TopN终端流量列表信息。 - 表4 TrafficStatisticInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 hostName string 0~256个字符。 - 终端名称。 "station1" upTraffic float [0-3.4028235E38] - 上行流量。 34225.0 downTraffic float [0-3.4028235E38] - 下行流量。 34225.0 unit string 0~256个字符。 - 流量单位。 "Byte" 返回状态码为400:参数错误,查询失败。 详细信息请参见实际响应消息体。
  • URI /controller/campus/v1/performanceservice/station/traffic/statistic/site/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID,UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceType 是 string AP FW AC ALL AP 查询过滤的设备类型,AP---AP设备、FW---FW设备、AC---AC(Fit AP)设备、ALL---所有设备。 "AP" timeDimension 是 string day week month year day 统计周期,day---天、week---周、month---月、year---年。 "day" top 是 int32 0 5 10 15 20 5 top数据个数,支持0、5、10、15、20。0代表查询所有终端流量。 5 beginTime 是 int64 [0-2208959999] - 起始格林威治时间(时间精度对应到秒)。 1537408636 endTime 是 int64 [0-2208959999] - 结束格林威治时间(时间精度对应到秒)。 1537495036
  • 请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/station/traffic/statistic/site/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca?deviceType=AP&timeDimension=day&top=5&beginTime=1537408636&endTime=1537495036 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:接口调用成功,响应体参考TrafficStatisticDataResp。 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" : [ { "hostName" : "station1", "upTraffic" : 34225.0, "downTraffic" : 34225.0, "unit" : "Byte" } ] } 返回状态码为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/lswstpprotection/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/stpprotection/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 { "ids" : ["fbb684c8-0d37-406f-bafa-4b06d6151e2e"] }
  • 响应示例 返回状态码为200:删除交换机STP保护配置成功。 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" : ["fbb684c8-0d37-406f-bafa-4b06d6151e2e"], "fail" : { "errcode" : "0", "errmsg" : "", "ids" : ["fbb684c8-0d37-406f-bafa-4b06d6151e2e"] } } 返回状态码为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/networkservice/networkconfig/net/lswstpprotection/sites/{siteId}/stpprotection/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/net/site/inter/connect/ipsec/tunnel?id=fbb684c8-0d37-496f-bafa-4b06d5151e2e&siteId=fbb684c8-0d37-496f-bafa-4b06d5151e2e&vpnId=00000000-0000-0000-0000-000000000000&keyWord=Tunnel0/0/1&pageIndex=1&pageSize=20&order=asc 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:接口调用成功,响应体参考QueryIpsecTunnelResponse。 表2 QueryIpsecTunnelResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 每页显示数量。 20 pageIndex int32 - - 当前页数 1 data ARRAY_REFERENCE 详细请参见表5。 端口信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:接口调用成功,响应体参考QueryIpsecTunnelResponse。 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" : 200, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "securityZone" : "underlay_untrust" } ] } 返回状态码为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/site/inter/connect/ipsec/tunnel 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 string - - Ipsec Tunnel id。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" siteId 否 string - - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" vpnId 否 string - - VPN ID。 "00000000-0000-0000-0000-000000000000" keyWord 否 string - - 查询关键字。 "Tunnel0/0/1" pageIndex 否 int32 - 1 当前页数,默认是1。 1 pageSize 否 int32 - 20 每页显示数量,默认是20。 20 order 否 string 0~20个字符。 - 按照Tunnel端口名排序,asc:升序,desc:降序,不填写不排序。 "asc"
  • 响应参数 返回状态码为200:SSID全部删除成功,返回结构体参见APDeleteSsidResponse。 APDeleteSsidResponse对象的参数列表,详细请参见表4。 返回状态码为207:SSID部分删除成功,返回结构体参见APDeleteSsidResponse。 APDeleteSsidResponse对象的参数列表,详细请参见表4。 返回状态码为400:SSID删除失败,返回结构体参见APDeleteSsidResponse。 APDeleteSsidResponse对象的参数列表,详细请参见表4。 返回状态码为500:内部服务异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v3/networkconfig/customized/fbde1c5d-5b94-49e3-a912-48641015e45c/apssid/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 { "ids" : [ "de5813f8ff1e41f5ba9c324da70b49ed" ] }
  • 响应示例 返回状态码为200:SSID全部删除成功,返回结构体参见APDeleteSsidResponse。 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" : [ "de5813f8ff1e41f5ba9c324da70b49ed" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" } ] } 返回状态码为207:SSID部分删除成功,返回结构体参见APDeleteSsidResponse。 HTTP/1.1 207 Multi-Status 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" : [ "de5813f8ff1e41f5ba9c324da70b49ed" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" } ] } 返回状态码为400:SSID删除失败,返回结构体参见APDeleteSsidResponse。 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 { "errcode" : "0", "errmsg" : "", "success" : [ "de5813f8ff1e41f5ba9c324da70b49ed" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The site ID format is incorrect or the site does not exist", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" } ] } 返回状态码为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/v3/networkconfig/customized/{siteId}/apssid/action/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点模板个性化标识,UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c"
  • 请求示例 HTTP的示例 POST /controller/campus/v1/authconfigservice/accessconfig/timeflowconfig 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 { "timeFlowName" : "one", "siteId" : "75f8ed0f-810a-4ff5-8e64-67c81312d01c", "enableTrafficLimitMode" : true, "trafficLimitMode" : 1, "trafficLimit" : 34, "trafficLimitValue" : 34, "enableDurationLimitMode" : true, "durationLimitMode" : 1, "durationLimit" : 34, "durationLimitValue" : 34, "isReCount" : true, "isAnonymous" : false, "userGroupIds" : [ "33f8ed0f-810a-4ff5-8e64-67c81312d012" ], "description" : "a policy", "policyType" : 1, "oneTimeValue" : 60, "terminalTimeValue" : 1440, "terminalTimeUnit" : 1, "terminalFlowValue" : 1024, "terminalFlowUnit" : 1, "terminalReCountEnable" : true, "redirectEnable" : false, "redirectUrl" : "https://xxx.xxx.xxx.xxx" }
  • 响应示例 返回状态码为200:添加成功,响应体参考TimeFlowConfigsOutputDto。 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" : "", "total" : 10, "data" : [ { "id" : "a91e169602a24a68bad4aa639359c8cf", "timeFlowName" : "one", "siteId" : "75f8ed0f-810a-4ff5-8e64-67c81312d01c", "enableTrafficLimitMode" : true, "trafficLimitMode" : 1, "trafficLimit" : 34, "trafficLimitValue" : 34, "enableDurationLimitMode" : true, "durationLimitMode" : 1, "durationLimit" : 34, "durationLimitValue" : 34, "isReCount" : true, "isAnonymous" : false, "userGroupIds" : [ "33f8ed0f-810a-4ff5-8e64-67c81312d012" ], "description" : "a policy", "policyType" : 1, "oneTimeValue" : 60, "terminalTimeValue" : 1440, "terminalTimeUnit" : 1, "terminalFlowValue" : 1024, "terminalFlowUnit" : 1, "terminalReCountEnable" : true, "redirectEnable" : false, "redirectUrl" : "https://xxx.xxx.xxx.xxx" } ] } 返回状态码为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的示例 PUT /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 { "id":"64b15bd66c8f44c086994e35b32aac1c", "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 } } } }
  • 响应示例 返回状态码为200:修改认证模板成功,响应体参考LswAuthConfigResponse。 HTTPS 200 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0", "errmsg":"", "data":[ { "id":"64b15bd66c8f44c086994e35b32aac1c", "name":"test6666", "ssidName":"test6666", "authMode":1, "escapeStrategy":0, "escapeStrategyId":null, "escapePolicyName":null, "apFreeAuthEnable":null, "forceDomainEnable": true, "preAuthPrivilege":{ "preAuthPrivilegeEnable":false, "vlan":null }, "authFailPrivilege":{ "authFailPrivilegeEnable":false, "vlan":null }, "voiceDeviceNoAuth":{ "voiceDeviceNoAuthEnable":null, "vlan":null }, "hasPermission":null, "portalConfigDto":{ "pagePushMode":0, "freeAuthEnable":false, "freeAuthExpired":null, "freeAuthExpiredUnit":null, "internalPortalConfigDto":{ "portalProtocol":0, "pushProtocol":0, "pushMethod":0, "pushPageId":"9012b661-1750-4338-b84d-8ecf672bb790", "pushPageName":"默认用户名密码认证定制页面", "ipv6Enable":false, "accountingEnable":false, "accountingPeriod":null, "anonymousAuthEnable":null, "normalAuthEnable":null, "normalAccessConfigDto":{ "registerEnable":false, "userExpiredTime":null, "userExpiredUnit":null, "passwdExpiredTime":null, "passwdExpiredUnit":null, "accessMaxNumber":null, "userGroupId":null, "userGroupName":null }, "smsAuthEnable":null, "smsAccessConfigDto":null, "weChatUrlAuthEnable":null, "weChatAuthEnable":null, "socialMediaAuthEnable":null, "twitterAuthEnable":null, "sinaWeiboAuthEnable":null, "qqAuthEnable":null, "googleAuthEnable":null, "weComAuthEnable":null, "dingTalkEnable":null, "passcodeAuthEnable":null, "oneKeyAuthEnable":null, "qrCodeAuthEnable":null, "masterPortalTemplateId":null, "masterPortalTemplateName":null, "slavePortalServerEnable":null, "slavePortalTemplateId":null, "slavePortalTemplateName":null, "authorRedirectUrlParamEnable":null }, "relayPortalConfigDto":null, "thirdPortalConfigDto":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
  • 响应示例 返回状态码为200:删除成功,响应体参考CommonResponse。 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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/snmp/user/00000000-0000-0000-0000-000000000000/mibView/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 { "names" : [ "view1" ] }
  • 响应示例 返回状态码为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" : "", "totalRecords" : 100, "data" : [ { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "isExclusiveResource" : false, "vpnNumber" : 100, "bandWidth" : 100, "siteNumber" : 100, "sdwanBandwidth" : 100, "encryptedSdwanBandwidth" : 100, "vxlanBandwidth" : 100, "status" : 0, "role" : "Interworking Gateway", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1" } ] } 返回状态码为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/sdwan/v1/naas/virtual/device/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 { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "deviceId" : "00000000-0000-0000-0000-000000000000", "status" : 0, "sort" : "+deviceName,-deviceName", "pageIndex" : 1, "pageSize" : 10 }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryPara 是 REFERENCE 详细请参见表2。 子设备信息。 - 表2 VirtualDeviceQueryRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parentId 否 string 0~128个字符。 - 父设备ID。 "00000000-0000-0000-0000-000000000000" deviceName 否 string 0~128个字符。 - 设备名称。 "tenant1" deviceId 否 string 0~128个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" status 否 int32 [0-4] - 子设备状态。0:注册异常,1:上线异常,2:离线异常,3:在线,4:离线。 0 sort 否 string 0~128个字符。 - 排序。 "+deviceName,-deviceName" pageIndex 否 int32 [1-1000] - 页面索引,不填时默认为1。 1 pageSize 否 int32 [1-100] - 页面大小。 10
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全