云服务器内容精选

  • 请求示例 HTTP的示例 POST /controller/campus/v1/accesscfg/device/authdevice/action/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 { "ids" : ["5c37d9e8-cdf6-11e8-a4fc-286ed488df6b"] }
  • 响应示例 返回状态码为200:删除成功,响应体参考ApiBatchDeleteDto。 HTTP/1.1 200 OK Date: Tue,16 Aug 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "success": [ "ba3490cb-efba-457d-96a6-320f30ffa7f7" ], "failure": [ { "errcode": "0x00c80006", "errmsg": "The device does not exist.", "id": "8a660b9c-a198-4b67-ae0d-4d1430847df1" } ] "errcode" : "0", "errmsg" : "", "data" : { "name" : "device", "description" : "this is device", "ip" : "10.254.254.254", "backupIp" : "10.254.254.253", "deviceGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "series" : "Huawei NAC", "enableRadius" : true, "radiusParam" : { "accountingKey" : "******", "authenKey" : "******", "coaPort" : 1700, "accountingPeriod" : 5, "macPwdEnable" : false, "macAuthPwd" : "******", "radiusServiceTypeEnable" : false, "radiusServiceTypeDevice" : 8, "radiusServiceTypeTerminal" : 4 }, "enablePortal" : true, "portalParam" : { "protol" : "CMCC Portal", "portalKey" : "******", "urlKey" : "******", "stations" : ["10.254.254.254"], "enableUserSync" : false, "port" : 80, "portalServiceTypeEnable" : true, "portalServiceTypeTerminal" : 4 }, "enableTacacs" : true, "tacacsParam" : { "key" : "******" }, "id" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" } } 返回状态码为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:查询认证设备成功,响应体参考DeviceListApiDto。 HTTP/1.1 200 OK Date: Tue,16 Aug 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "pageIndex" : "1", "pageSize" : "40", "totalRecords" : 1000, "data" : [ { "name" : "device", "description" : "this is device", "ip" : "10.254.254.254", "backupIp" : "10.254.254.253", "deviceGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "series" : "Cisco Catalyst", "enableRadius" : true, "radiusParam" : { "accountingKey" : "******", "authenKey" : "******", "coaPort" : 1700, "accountingPeriod" : 5, "macPwdEnable" : false, "macAuthPwd" : "******", "radiusServiceTypeEnable" : false, "radiusServiceTypeDevice" : 8, "radiusServiceTypeTerminal" : 4 }, "enablePortal" : true, "portalParam" : { "protol" : "CMCC Portal", "portalKey" : "******", "urlKey" : "******", "stations" : ["10.254.254.254"], "enableUserSync" : false, "port" : 80, "portalServiceTypeEnable" : true, "portalServiceTypeTerminal" : 4 }, "enableTacacs" : true, "tacacsParam" : { "key" : "******" }, "id" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" } ] } 返回状态码为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/accesscfg/device/authdevice/list 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 { "pageIndex" : "1", "pageSize" : "40", "deviceGroupId" : "51cdcbe3-5e14-492b-ab27-86950b661d19", "name" : "devname" }
  • 响应参数 返回状态码为200:查询认证设备成功,响应体参考DeviceListApiDto。 表3 DeviceListApiDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex int32 [0-2147483647] - 页面索引。 "1" pageSize int32 [0-1000] - 页面大小。 "40" totalRecords int32 - - 总数。 1000 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表8。 认证设备列表。 - 返回状态码为400:校验异常 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryInputDto 是 REFERENCE 详细请参见表2。 查询认证设备参数。 - 表2 ApiQueryInputDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 int32 [0-2147483647] - 页面索引。 "1" pageSize 是 int32 [0-1000] - 页面大小。 "40" deviceGroupId 否 string - - 准入设备组ID,uuid格式。 "51cdcbe3-5e14-492b-ab27-86950b661d19" name 否 string 0~64个字符。 - 设备名称,支持模糊查询。 "devname"
  • 请求示例 HTTP的示例 POST /controller/campus/v1/accesscfg/device/authdevice 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" : "device", "description" : "this is device", "ip" : "10.254.254.254", "backupIp" : "10.254.254.253", "deviceGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "deviceGroupName" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "series" : "Cisco Catalyst", "apn" : "APN-1", "enableRadius" : true, "radiusParam" : { "accountingKey" : "Example@123", "authenKey" : "Example@123", "coaPort" : 1700, "accountingPeriod" : 5, "macPwdEnable" : false, "macAuthPwd" : "Example@123", "radiusServiceTypeEnable" : false, "radiusServiceTypeDevice" : 8, "radiusServiceTypeTerminal" : 4 }, "enablePortal" : true, "portalParam" : { "protol" : "CMCC Portal", "portalKey" : "Example@123", "urlKey" : "Example@123", "stations" : ["10.254.254.254"], "enableUserSync" : false, "port" : 80, "portalServiceTypeEnable" : true, "portalServiceTypeTerminal" : 4, "portalIp" : "10.254.254.254", "httpProtocol" : "HTTPS" }, "enableTacacs" : true, "tacacsParam" : { "key" : "Example@123" }, "deviceGroupInfos" : [ { "devGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "devGroupName" : "devGroupName1" } ] }
  • 响应示例 返回状态码为201:创建成功,响应体参考DeviceApiResponse。 HTTP/1.1 200 OK Date: Tue,16 Aug 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "data" : { "name" : "device", "description" : "this is device", "ip" : "10.254.254.254", "backupIp" : "10.254.254.253", "deviceGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "series" : "Cisco Catalyst", "enableRadius" : true, "radiusParam" : { "accountingKey" : "******", "authenKey" : "******", "coaPort" : 1700, "accountingPeriod" : 5, "macPwdEnable" : false, "macAuthPwd" : "******", "radiusServiceTypeEnable" : false, "radiusServiceTypeDevice" : 8, "radiusServiceTypeTerminal" : 4 }, "enablePortal" : true, "portalParam" : { "protol" : "CMCC Portal", "portalKey" : "******", "urlKey" : "******", "stations" : ["10.254.254.254"], "enableUserSync" : false, "port" : 80, "portalServiceTypeEnable" : true, "portalServiceTypeTerminal" : 4 }, "enableTacacs" : true, "tacacsParam" : { "key" : "******" }, "id" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" } } 返回状态码为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:修改成功,响应体参考DeviceApiResponse。 HTTP/1.1 200 OK Date: Thu,01 Sep 2022 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" : "device", "description" : "this is device", "ip" : "10.254.254.254", "backupIp" : "10.254.254.253", "deviceGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "series" : "Cisco Catalyst", "enableRadius" : true, "radiusParam" : { "accountingKey" : "******", "authenKey" : "******", "coaPort" : 1700, "accountingPeriod" : 5, "macPwdEnable" : false, "macAuthPwd" : "******", "radiusServiceTypeEnable" : false, "radiusServiceTypeDevice" : 8, "radiusServiceTypeTerminal" : 4 }, "enablePortal" : true, "portalParam" : { "protol" : "CMCC Portal", "portalKey" : "******", "urlKey" : "******", "stations" : ["10.254.254.254"], "enableUserSync" : false, "port" : 80, "portalServiceTypeEnable" : true, "portalServiceTypeTerminal" : 4 }, "enableTacacs" : true, "tacacsParam" : { "key" : "******" }, "id" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" } } 返回状态码为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的示例 PUT /controller/campus/v1/accesscfg/device/authdevice 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" : "device", "description" : "this is device", "ip" : "10.254.254.254", "backupIp" : "10.254.254.253", "deviceGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "deviceGroupName" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "series" : "Cisco Catalyst", "apn" : "APN-1", "enableRadius" : true, "radiusParam" : { "accountingKey" : "Example@123", "authenKey" : "Example@123", "coaPort" : 1700, "accountingPeriod" : 5, "macPwdEnable" : false, "macAuthPwd" : "Example@123", "radiusServiceTypeEnable" : false, "radiusServiceTypeDevice" : 8, "radiusServiceTypeTerminal" : 4 }, "enablePortal" : true, "portalParam" : { "protol" : "CMCC Portal", "portalKey" : "Example@123", "urlKey" : "Example@123", "stations" : ["10.254.254.254"], "enableUserSync" : false, "port" : 80, "portalServiceTypeEnable" : true, "portalServiceTypeTerminal" : 4, "portalIp" : "10.254.254.254", "httpProtocol" : "HTTPS" }, "enableTacacs" : true, "tacacsParam" : { "key" : "Example@123" }, "deviceGroupInfos" : [ { "devGroupId" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b", "devGroupName" : "devGroupName1" } ], "id" : "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 device 是 REFERENCE 详细请参见表2。 待修改认证设备参数。 - 表2 DeviceApiDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~64个字符。 - 设备名称,1~64位的字符串,且不可包含特殊字符?!~@#$%^&*().。 "device" description 否 string 0~255个字符。 - 设备描述,0~255位字符,不能以=+-@作为开头。 "this is device" ip 是 string 1~128个字符。 - ipV4地址,enablePortal为false时支持掩码。 "10.254.254.254" backupIp 否 string 0~128个字符。 - 备份ip地址,交换机或WAC双链路部署时填写,enablePortal为false时支持掩码 "10.254.254.253" deviceGroupId 否 string 0~64个字符。 - 设备组标识。该字段和deviceGroupInfos不同时生效,如果deviceGroupInfos入参有信息优先生效deviceGroupInfos字段信息 "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" deviceGroupName 否 string 0~64个字符。 - 设备组名称。 "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b" series 是 string Huawei Engine Cisco Catalyst H3C S Huawei NAC Cisco WLC Aruba OS Other Huawei USG Huawei ME60/NE40E Cisco Crystal Huawei V600 5GC - 设备系列,Crystal同Catalyst。选择5GC系列后,系列不支持修改,且不支持配置Portal和Tacacs。 "Cisco Catalyst" apn 否 string 0~64个字符。 - APN名称。 "APN-1" enableRadius 否 boolean true false false 是否已配置Radius对接参数。当enableRadius为true,radiusParam必填,为false时radiusParam无需填写。 true radiusParam 否 REFERENCE 详细请参见表3。 Radius参数信息 - enablePortal 否 boolean true false false 是否已配置Portal对接参数。当enablePortal为true,portalParam必填,为false时portalParam无需填写。 true portalParam 否 REFERENCE 详细请参见表4。 Potral参数信息 - enableTacacs 否 boolean true false false 是否已配置HWTACA CS 对接参数。当enableTacacs为true,tacacsParam必填,为false时tacacsParam无需填写。 true tacacsParam 否 REFERENCE 详细请参见表5。 TACACS参数信息 - deviceGroupInfos 否 ARRAY_REFERENCE 0-10个列表项,详细请参见表6。 多个设备组信息。该字段和deviceGroupId不同时生效,如果deviceGroupInfos入参有信息优先生效该字段信息 - id 是 string 1~64个字符。 - 认证设备ID,uuid格式。 "5c37d9e8-cdf6-11e8-a4fc-286ed488df6b"