云服务器内容精选

  • 响应示例 返回状态码为200:接口执行成功 HTTP/1.1 200 OK { "errorCode": 0, "errorMsg": null, "topoNodes": [ { "nodeId": "eb2d57d5-e56a-4867-b9a5-1e5915ba5e85", "tenantId": null, "siteId": null, "resType": "preDeployAp", "name": "AP-536", "remark": null, "parentNodeId": "d681914f-af8a-4e67-9e0d-199cc2fcf745", "posX": 42.0, "posY": 723.0, "longitude": null, "latitude": null }, { "nodeId": "1be6d950-df08-4893-a515-f9eee403bfd5", "tenantId": null, "siteId": null, "resType": "preDeployAp", "name": "AP-535", "remark": null, "parentNodeId": "d681914f-af8a-4e67-9e0d-199cc2fcf745", "posX": 42.0, "posY": 677.0, "longitude": null, "latitude": null } ], "totalSize": 2 } 返回状态码为400:参数错误 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为403:URL鉴权 HTTP/1.1 403 Forbidden Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为406:流控限流 HTTP/1.1 406 Not Acceptable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为502:网关错误 HTTP/1.1 502 Bad Gateway Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为503:服务不可用 HTTP/1.1 503 Service Unavailable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为504:表示时间超时,总线超时时间300s HTTP/1.1 504 Gateway Timeout Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:接口执行成功 表2 OpenApiTopoNodeListResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 状态码 - errorMsg string - - 新增、修改、删除异常时的错误信息 - totalSize int32 - - 拓扑节点总数 - topoNodes ARRAY_REFERENCE 详细请参见表3。 拓扑节点列表 - 表3 OpenApiTopoNodeBaseModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nodeId string - - 对象ID - tenantId string - - 租户ID - siteId string - - 站点ID - resType string - - 资源类型 - name string - - 对象名称 - remark string - - 描述信息 - parentNodeId string - - 父节点ID - posX double - - 节点的X坐标 - posY double - - 节点的Y坐标 - longitude double - - 经度 - latitude double - - 纬度 - 返回状态码为400:参数错误 详细信息请参见实际响应消息体。 返回状态码为403:URL鉴权 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到 详细信息请参见实际响应消息体。 返回状态码为406:流控限流 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误 详细信息请参见实际响应消息体。 返回状态码为502:网关错误 详细信息请参见实际响应消息体。 返回状态码为503:服务不可用 详细信息请参见实际响应消息体。 返回状态码为504:表示时间超时,总线超时时间300s 详细信息请参见实际响应消息体。
  • 请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-AC CES S-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/network/wlan/region-topo/node-list?params={page : 1, limit : 20, sortColumn : name, sortMode : asc, parentNodeId : 3, resTypes : [ Region ], name : test, remark : , posX : 954, poxY : 305, longitude : 0.0, latitude : 0.0}' HTTP的示例 GET /rest/openapi/network/wlan/region-topo/node-list?params={page : 1, limit : 20, sortColumn : name, sortMode : asc, parentNodeId : 3, resTypes : [ Region ], name : test, remark : , posX : 954, poxY : 305, longitude : 0.0, latitude : 0.0} 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 /rest/openapi/network/wlan/region-topo/node-list 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 params 是 string 0~8192个字符。 - 查询拓扑节点的过滤条件(参数项含义可参考OpenApiTopoNodeQueryModel模型)。 必填参数项:page、limit、siteId(站点Id,已规划站点时必填,其他场景不填该参数)。 可选参数项:sortColumn、sortMode、parentNodeId、resTypes、name、remark、posX、poxY、longitude、latitude。 {"page" : 1, "limit" : 20, "sortColumn" : "name", "sortMode" : "asc", "parentNodeId" : "3", "resTypes" : [ "Region" ], "name" : "test", "remark" : "", "posX" : 954, "poxY" : 305, "longitude" : 0.0, "latitude" : 0.0}
  • 响应示例 返回状态码为200:返回操作是否成功 HTTP/1.1 200 OK Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errorCode" : "", "errorMsg" : "", "data" : [ { "operErrorCode" : "", "resultMsg" : "", "tenantId" : "", "name" : "", "objId" : "", "siteId" : "", "parentObjId" : "" } ] } 返回状态码为400:参数错误 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为403:URL鉴权 HTTP/1.1 403 Forbidden Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为406:流控限流 HTTP/1.1 406 Not Acceptable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为502:网关错误 HTTP/1.1 502 Bad Gateway Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为503:服务不可用 HTTP/1.1 503 Service Unavailable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为504:表示时间超时,总线超时时间300s HTTP/1.1 504 Gateway Timeout Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:返回操作是否成功 OpenApiOperationApResponse对象的参数列表,详细请参见表4。 返回状态码为400:参数错误 详细信息请参见实际响应消息体。 返回状态码为403:URL鉴权 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到 详细信息请参见实际响应消息体。 返回状态码为406:流控限流 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误 详细信息请参见实际响应消息体。 返回状态码为502:网关错误 详细信息请参见实际响应消息体。 返回状态码为503:服务不可用 详细信息请参见实际响应消息体。 返回状态码为504:表示时间超时,总线超时时间300s 详细信息请参见实际响应消息体。
  • 请求示例 cURL的示例 curl -k -s -L -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/network/wlan/region-topo/aps/action/delete' -d '{ "siteId" : "", "parentObjId" : "", "objIds" : [ "" ] }' HTTP的示例 POST /rest/openapi/network/wlan/region-topo/aps/action/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 { "siteId" : "", "parentObjId" : "", "objIds" : [ "" ] }
  • 响应参数 返回状态码为200:返回操作是否成功 OpenApiOperationRegionResponse对象的参数列表,详细请参见表3。 返回状态码为400:参数错误 详细信息请参见实际响应消息体。 返回状态码为403:URL鉴权 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到 详细信息请参见实际响应消息体。 返回状态码为406:流控限流 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误 详细信息请参见实际响应消息体。 返回状态码为502:网关错误 详细信息请参见实际响应消息体。 返回状态码为503:服务不可用 详细信息请参见实际响应消息体。 返回状态码为504:表示时间超时,总线超时时间300s 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:返回操作是否成功 HTTP/1.1 200 OK { "errorCode": 0, "errorMsg": null, "data": [ { "operErrorCode": 0, "resultMsg": null, "tenantId": "efabceb476d7416291c7470270237613", "name": "N5-1", "regionType": 5, "objId": "e8175163-0761-414d-bef1-9cb0b493391c", "siteId": "4d7fafd6-5ea9-49b9-a295-f95a91b1f72c", "parentObjId": "0cb7cebc-3ed5-4c1f-848d-7dd797d5c386" } ] } 返回状态码为400:参数错误 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为403:URL鉴权 HTTP/1.1 403 Forbidden Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为406:流控限流 HTTP/1.1 406 Not Acceptable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为502:网关错误 HTTP/1.1 502 Bad Gateway Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为503:服务不可用 HTTP/1.1 503 Service Unavailable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为504:表示时间超时,总线超时时间300s HTTP/1.1 504 Gateway Timeout Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 cURL的示例 curl -k -s -L -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/network/wlan/region-topo/regions/action/delete' -d '{ "siteId" : "", "objIds" : [ "" ] }' HTTP的示例 POST /rest/openapi/network/wlan/region-topo/regions/action/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 { "siteId" : "", "objIds" : [ "" ] }
  • 响应示例 返回状态码为200:接口执行成功 HTTP/1.1 200 OK { "errorCode": 0, "errorMsg": null, "imgData": { "tenantId": null, "bgImageName": "test.jpg", "fileSize": 389, "bgImageWidth": 1515.0, "bgImageHeight": 343.0, "totalShardCount": 1, "currentShardIndex": 0, "shardContent": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDACgcHiMeGSgjISMt" } } 返回状态码为400:参数错误 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为403:URL鉴权 HTTP/1.1 403 Forbidden Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为406:流控限流 HTTP/1.1 406 Not Acceptable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为502:网关错误 HTTP/1.1 502 Bad Gateway Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为503:服务不可用 HTTP/1.1 503 Service Unavailable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为504:表示时间超时,总线超时时间300s HTTP/1.1 504 Gateway Timeout Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/network/wlan/region-topo/background-image?regionId=0e6124e0-106d-4ecc-990e-0be0d04198ab&shardIndex=0' HTTP的示例 GET /rest/openapi/network/wlan/region-topo/background-image?regionId=0e6124e0-106d-4ecc-990e-0be0d04198ab&shardIndex=0 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:接口执行成功 表2 OpenApiTopoBgImageResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 状态码 - errorMsg string - - 新增、修改、删除异常时的错误信息 - imgData REFERENCE 详细请参见表3。 图片数据 - 表3 OpenApiBackgroundImageModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 tenantId string - - 租户ID - bgImageName string - - 背景图名称 - fileSize int64 - - 图片文件大小,单位是字节 - bgImageWidth double - - 背景图宽度 - bgImageHeight double - - 背景图高度 - totalShardCount int32 - - 分片总数量 - currentShardIndex int32 - - 分片索引 - shardContent byte - - 分片二进制字节流(Base64编码) - 返回状态码为400:参数错误 详细信息请参见实际响应消息体。 返回状态码为403:URL鉴权 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到 详细信息请参见实际响应消息体。 返回状态码为406:流控限流 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误 详细信息请参见实际响应消息体。 返回状态码为502:网关错误 详细信息请参见实际响应消息体。 返回状态码为503:服务不可用 详细信息请参见实际响应消息体。 返回状态码为504:表示时间超时,总线超时时间300s 详细信息请参见实际响应消息体。
  • URI /rest/openapi/network/wlan/region-topo/background-image 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 regionId 是 string 0~64个字符。 - 区域ID "0e6124e0-106d-4ecc-990e-0be0d04198ab" shardIndex 是 int32 - - 分片索引(从0开始) 0
  • 响应示例 返回状态码为200:返回操作是否成功 HTTP/1.1 200 OK { "errorCode": 0, "errorMsg": null, "data": [ { "operErrorCode": null, "resultMsg": null, "tenantId": "efabceb476d7416291c7470270237613", "name": "AP00000A886E79", "objId": "320f732e-e319-3d3b-a2b0-aef4030dff42", "siteId": "4d7fafd6-5ea9-49b9-a295-f95a91b1f72c", "parentObjId": "bf737be5-60aa-4c8a-9d92-71590d5d6ca8" } ] } 返回状态码为400:参数错误 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为403:URL鉴权 HTTP/1.1 403 Forbidden Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为406:流控限流 HTTP/1.1 406 Not Acceptable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为502:网关错误 HTTP/1.1 502 Bad Gateway Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为503:服务不可用 HTTP/1.1 503 Service Unavailable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为504:表示时间超时,总线超时时间300s HTTP/1.1 504 Gateway Timeout Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive