云服务器内容精选

  • 请求示例 HTTP的示例 DELETE /controller/campus/api/v1/devices/lldp/scan/task/ee4d21b7-27cf-4b2e-af7a-8231a31152c0 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:删除发现任务响应成功,响应体参考DeleteLldpCollectTaskResp。 表2 DeleteLldpCollectTaskResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码 - errmsg string - - 错误信息 - 返回状态码为400:接口参数校验异常,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:删除发现任务响应成功,响应体参考DeleteLldpCollectTaskResp。 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" : "", "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
  • 响应示例 返回状态码为200:接口调用成功,响应体参考LldpCollectStatisticsResp。 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" : "", "id" : "ee4d21b7-27cf-4b2e-af7a-8231a31152c0", "status" : 1, "createTime" : 1612853177000, "updateTime" : 1612853226000, "statistics" : [ { "id" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "name" : "00500829380000000000", "neighbourDevNum" : 100, "allowAddNeighbourDevNum" : 100 } ] } 返回状态码为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:接口调用成功,响应体参考LldpCollectStatisticsResp。 表2 LldpCollectStatisticsResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 接口调用结果的描述信息。 "" id string - - 任务ID。 "ee4d21b7-27cf-4b2e-af7a-8231a31152c0" status int32 - - 任务状态 1:开始;2:结束。 1 createTime int64 - - 任务创建时间。 1612853177000 updateTime int64 - - 任务刷新时间。 1612853226000 statistics ARRAY_REFERENCE 详细请参见表3。 LLDP采集统计信息 - 表3 LldpCollectDeviceStatistics对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 源设备ID。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" name string - - 源设备名称。 "00500829380000000000" neighbourDevNum int32 - - 每个源设备采集的设备总数,为0可能是无邻居设备或者设备离线或者采集超时或者LLDP开关未打开。 100 allowAddNeighbourDevNum int32 - - 每个源设备采集的允许添加设备总数,需要去除已经添加的设备数,为0可能是设备已添加到控制器或者无邻居设备或者设备离线或者采集超时或者LLDP开关未打开。 100 返回状态码为400:接口参数校验异常,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/devices/lldp/scan/statistics?taskId=ee4d21b7-27cf-4b2e-af7a-8231a31152c0 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:接口查询成功,响应体参考LldpCollectDevicesResp。 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" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "tenantId" : "00000000-0000-0000-0000-000000000001", "name" : "00500829380000000000", "esn" : "00500829380000000000", "status" : 4, "model" : "AP6050DN", "type" : "AP", "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "siteName" : "test1", "latestOnlineTime" : "2021-06-10 21:02:18", "deviceRoles" : [ "" ] } ], "total" : 100 } 返回状态码为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/api/v1/devices/lldp/collect/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" : 20, "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "keyword" : "device1", "latestOnlineTimeBegin" : 1623980071, "latestOnlineTimeEnd" : 1623990071, "deviceRoles" : [ "" ] }
  • 请求示例 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:接口调用成功,响应体参考LldpDiscoverDevicesResp。 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" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "name" : "00500829380000000000", "esn" : "00500829380000000000", "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "siteName" : "test1", "model" : "AP6050DN", "type" : "AP", "neighbourDevName" : "00500829380000000000" } ], "total" : 100 } 返回状态码为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:接口调用成功,响应体参考LldpDiscoverDevicesResp。 表3 LldpDiscoverDevicesResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 接口调用结果的描述信息。 "" data ARRAY_REFERENCE 详细请参见表4。 采集到的邻居设备列表。 - total int32 - - 总数。 100 表4 LldpDiscoverDevice对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 源设备ID。 "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42" name string - - 源设备名称。 "00500829380000000000" esn string - - 源设备ESN。 "00500829380000000000" siteId string - - 源设备站点ID。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" siteName string - - 源设备站点名称。 "test1" model string - - 邻居设备款型。 "AP6050DN" type string - - 邻居设备类型。 "AP" neighbourDevName string - - 邻居设备名称。 "00500829380000000000" 返回状态码为400:接口参数校验异常,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/api/v1/devices/lldp/discover/result 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" : 20, "keyword" : "device1", "type" : "AP", "taskId" : "ee4d21b7-27cf-4b2e-af7a-8231a31152c0" }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 getLldpDiscoverResultDto 是 REFERENCE 详细请参见表2。 查询发现设备结果入参。 - 表2 GetLldpDiscoverResultDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-2147483647] - 页码。 1 pageSize 否 int32 [0-300] - 每页大小。 20 keyword 否 string 0~256个字符。 - 模糊查询字段,支持设备名称,设备esn,为空查询所有。 "device1" type 否 string 0~64个字符。 - 设备类型,AP,LSW,FW,AR,为空不区分类型查询。 "AP" taskId 否 string 36个字符。 - 任务ID。 "ee4d21b7-27cf-4b2e-af7a-8231a31152c0"