云服务器内容精选

  • 响应参数 返回状态码为200:插卡操作成功,响应体参考CardOperationOutputDto。 表3 CardOperationOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 错误信息。 "error" 返回状态码为400:校验异常,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/apiot/card/operation 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 { "deviceId" : "00000000-0000-0000-0000-000000000000", "slot" : 1, "operation" : "reboot" }
  • 响应示例 返回状态码为200:插卡操作成功,响应体参考CardOperationOutputDto。 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" : "error" } 返回状态码为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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 requestDto 是 REFERENCE 详细请参见表2。 IOT插卡信息。 - 表2 IotCardOperationDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 0~64个字符。 - AP的设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" slot 是 integer [0-8] - 插卡槽位号。 1 operation 是 string reboot reset-factory-configuration switch-firmware reset-network-configuration - 操作类型,该字段可以设置为以下几种。 a) reboot:重启 b) reset-factory-configuration:恢复出厂配置 c) switch-firmware:切换分区 d) reset-network-configuration:重置网络配置 "reboot"
  • 响应示例 返回状态码为200:查询成功,响应体参考EthernetCardOutputDto。 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" : "查询失败", "totalRecords" : 20, "pageIndex" : 1, "pageSize" : 20, "data" : [ { "apName" : "ap-1", "apEsn" : "2102350KGF9WJ9000124", "interfaceName" : "GigabitEthernet1/0/1", "cardSlot" : 1, "cardStatus" : "absent", "cardConnectStatus" : "match", "interfaceIndex" : 1, "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceStatus" : 1, "upwardSpeed" : 2500, "downwardSpeed" : 2500, "upwardTraffic" : 2500, "downwardTraffic" : 2500, "receivePackages" : 2500, "sendPackages" : 2500, "cardIp" : "10.1.1.1", "cardMac" : "xx-xx-xx-xx-xx-xx", "cardSn" : "111", "centerFrequency" : 2500, "bandWidth" : 2500, "serverConnectStatus" : 0, "firmwareVersion" : "1.1.4 (516)", "hardwareVersion" : "3.1.1 (932)", "subnetMask" : "24", "gatewayAddress" : "0.0.0.0", "physicalConnectType" : "PCIE" } ] } 返回状态码为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:查询成功,响应体参考EthernetCardOutputDto。 表3 EthernetCardOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码,当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 错误信息。 "查询失败" totalRecords integer [0-2147483647] - 总数量。 20 pageIndex integer [0-2147483647] - 页面索引。 1 pageSize integer [0-2147483647] - 每页展示数量。 20 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表4。 网口插卡数据。 - 表4 EthernetCardDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 apName string 0~64个字符。 - AP名称。 "ap-1" apEsn string 0~64个字符。 - AP序列号。 "2102350KGF9WJ9000124" interfaceName string 0~64个字符。 - 接口名称。 "GigabitEthernet1/0/1" cardSlot integer [0-8] - 卡槽号。 1 cardStatus string 0~64个字符。 present absent - 卡状态。 "absent" cardConnectStatus string 0~64个字符。 match mismatch - 卡连接状态。 "match" interfaceIndex integer - - 接口索引。 1 deviceId string 0~64个字符。 - 设备ID,UUID格式。 "00000000-0000-0000-0000-000000000000" deviceStatus integer 0 1 3 4 - 设备状态。取值范围:0---正常,1---告警,3---离线,4---未注册。 1 upwardSpeed int64 - - 接口上行速率,单位是bps。 2500 downwardSpeed int64 - - 接口下行速率,单位是bps。 2500 upwardTraffic int64 - - 接口上行流量,单位是Bytes。 2500 downwardTraffic int64 - - 接口下行流量,单位是Bytes。 2500 receivePackages int64 - - 接口上报周期内接收报文数。 2500 sendPackages int64 - - 接口上报周期内发送报文数。 2500 cardIp string 0~256个字符。 - 插卡IP。 "10.1.1.1" cardMac string 0~256个字符。 - 插卡MAC。 "xx-xx-xx-xx-xx-xx" cardSn string 0~64个字符。 - 插卡SN编号。 "111" centerFrequency int64 - - 中心频率,单位是GHz。 2500 bandWidth int64 - - 带宽,单位是Bytes。 2500 serverConnectStatus integer 0 1 - 与服务器连接状态,取值范围:0---建联、1---不建联。 0 firmwareVersion string 0~64个字符。 - 固件版本。 "1.1.4 (516)" hardwareVersion string 0~64个字符。 - 硬件版本。 "3.1.1 (932)" subnetMask string 0~64个字符。 - 子网掩码。 "24" gatewayAddress string 0~64个字符。 - 网关地址。 "0.0.0.0" physicalConnectType string 0~64个字符。 - 物理连接类型。 "PCIE" 返回状态码为400:校验异常,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/apiot/ethernetcardlist/sites/00000000-0000-0000-0000-000000000000?keyword=123&pageSize=20&pageIndex=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
  • URI /controller/campus/v1/oamservice/apiot/ethernetcardlist/sites/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 keyword 否 string 0~64个字符。 - 搜索关键字。匹配字段:设备ESN,是否必填:否。 "123" pageSize 否 integer [0-100] - 每页展示数量。是否必填:否。 20 pageIndex 否 integer [0-2147483647] - 页面索引。是否必填:否。 1
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryCmdResultOut。 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" : "查询失败", "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 1, "data" : [ { "id" : "b1ed5ce9-6f68-48f1-a040-c1aeca60b0ee", "deviceName" : "AP4050", "deviceEsn" : "21500829442SH5900299", "cardMac" : "xxxx-xxxx-xxxx", "iotSn" : "42001", "interface" : "Ethernet0/0/0", "issueTime" : "2019-11-01 11:13:17", "status" : "FAILED", "detail" : "Incorrect command parameter(s). Enter \"help\" to view a list of available commands.", "failReason" : "The command failed to pass transparent because the card is not installed." } ] } 返回状态码为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:查询成功,响应体参考QueryCmdResultOut。 表3 QueryCmdResultOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "查询失败" pageIndex int32 - - 分页的序号。 1 pageSize integer 10~100个字符。 - 分页大小。 10 totalRecords int32 - - 总数量。 1 data ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 AP IOT命令下发结果信息。 - 表4 IotCmdResultInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 该条记录的唯一标识ID。 "b1ed5ce9-6f68-48f1-a040-c1aeca60b0ee" deviceName string - - 设备名称。 "AP4050" deviceEsn string - - 设备ESN。 "21500829442SH5900299" cardMac string 0~256个字符。 - 插卡MAC。 "xxxx-xxxx-xxxx" iotSn string - - IOT插卡SN号。 "42001" interface string - - AP接口名称。 "Ethernet0/0/0" issueTime string - - 命令下发时间。 "2019-11-01 11:13:17" status string WAITTING EXECUTING SUCCESS FAILED - 插卡命令执行的状态。WAITTING等待执行命令,EXECUTING表示正在执行命令,SUCCESS表示执行命令成功,FAILED表示执行命令失败。 "FAILED" detail string - - 插卡命令执行返回详情。 "Incorrect command parameter(s). Enter \"help\" to view a list of available commands." failReason string - - 插卡命令执行失败的原因。 "The command failed to pass transparent because the card is not installed." 返回状态码为400:校验非法,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • URI /controller/campus/v1/oamservice/apiot/cmd/result/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID,UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 keyword 否 string 0~64个字符。 - 搜索关键字。模糊匹配字段:设备名称、设备ESN。 "123" pageSize 是 integer [10-100] - 每页展示数量。 20 pageIndex 是 integer [1-2147483647] - 页面索引。 1
  • 请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/apiot/cmd/result/00000000-0000-0000-0000-000000000000?keyword=123&pageSize=20&pageIndex=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