Ruckus SmartCell Gateway™ 200 RESTful Interface Reference Guide For Release 2.5.1 SCG 2 5 1 Rg 20140925
SCG 2.5.1 RESTful Interface Reference Guide scg-2-5-1-restful-interface-rg--20140925
2014-10-01
User Manual: Ruckus SCG 2.5.1 RESTful Interface Reference Guide
Open the PDF directly: View PDF .
Page Count: 69
Download | ![]() |
Open PDF In Browser | View PDF |
Ruckus Wireless SmartCell Gateway 200 ™ ™ RESTful Interface Reference Guide for Release 2.5.1 Part Number 800-70700-001 Rev A Published September 2014 www.ruckuswireless.com Copyright Notice and Proprietary Information Copyright 2014. Ruckus Wireless, Inc. All rights reserved. No part of this documentation may be used, reproduced, transmitted, or translated, in any form or by any means, electronic, mechanical, manual, optical, or otherwise, without prior written permission of Ruckus Wireless, Inc. (“Ruckus”), or as expressly provided by under license from Ruckus. Destination Control Statement Technical data contained in this publication may be subject to the export control laws of the United States of America. Disclosure to nationals of other countries contrary to United States law is prohibited. It is the reader’s responsibility to determine the applicable regulations and to comply with them. Disclaimer THIS DOCUMENTATION AND ALL INFORMATION CONTAINED HEREIN (“MATERIAL”) IS PROVIDED FOR GENERAL INFORMATION PURPOSES ONLY. RUCKUS AND ITS LICENSORS MAKE NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH REGARD TO THE MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE, OR THAT THE MATERIAL IS ERROR-FREE, ACCURATE OR RELIABLE. RUCKUS RESERVES THE RIGHT TO MAKE CHANGES OR UPDATES TO THE MATERIAL AT ANY TIME. Limitation of Liability IN NO EVENT SHALL RUCKUS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES, OR DAMAGES FOR LOSS OF PROFITS, REVENUE, DATA OR USE, INCURRED BY YOU OR ANY THIRD PARTY, WHETHER IN AN ACTION IN CONTRACT OR TORT, ARISING FROM YOUR ACCESS TO, OR USE OF, THE MATERIAL. Trademarks Ruckus Wireless, Ruckus, the bark logo, ZoneFlex, FlexMaster, ZoneDirector, SmartMesh, Channelfly, Smartcell, Dynamic PSK, and Simply Better Wireless are trademarks of Ruckus Wireless, Inc. in the United States and other countries. All other product or company names may be trademarks of their respective owners. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 2 Contents About This Guide Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 1 RESTful Interface Server Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 URI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Representation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 2 REST APIs GET All Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 GET One Access Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 GET All Radio Records of One Access Point. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 GET One Radio Record of One Access Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 GET All Radio Records of All Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 GET All WLAN Records of One Access Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 GET One WLAN Record of One Access Point. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 GET All WLAN Records of All Access Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 GET All Mobility Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 GET One Mobility Zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 GET All Controlblades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 GET One Controlblade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 GET All Statistics Between Start and End Time for One Access Point . . . . . . . . . . . . . . . 50 GET All Statistics Between Start and End Time for All Radios of One Access Point . . . . . 51 GET All Statistics Between Start and End Time for One Radio of One Access Point . . . . 53 GET All Statistics Between Start and End Time for All WLANs of One Access Point . . . . 54 GET All Statistics Between Start and End Time for One WLAN of One Access Point. . . . 56 GET All Statistics Between Start and End Time for All Mobility Zones . . . . . . . . . . . . . . . 58 SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 3 Contents GET All Statistics Between Start and End Time for One Mobility Zone. . . . . . . . . . . . . . . 59 GET All Statistics Between Start and End Time for All Controlblades. . . . . . . . . . . . . . . . 60 GET All Statistics Between Start and End time for One Controlblade . . . . . . . . . . . . . . . 62 GET All Events Between Start and End Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 GET All Alarms Between Start and End Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Index SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 4 About This Guide This SmartCell Gateway™ (SCG) 200 RESTful Interface Reference Guide describes the features provided by the SCG RESTful interface server. This guide is written for service operators and system administrators who are responsible for managing, configuring, and troubleshooting Ruckus Wireless devices. Consequently, it assumes a basic working knowledge of local area networks, wireless networking, and wireless devices. NOTE: This guide assumes that the SmartCell Gateway has already been installed as described in the Getting Started Guide. Most user guides and release notes are available in Adobe Acrobat Reader Portable Document Format (PDF) or HTML on the Ruckus Wireless Support Web site at https://support.ruckuswireless.com/documents. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 5 About This Guide Document Conventions Document Conventions Table 1 and Table 2 list the text and notice conventions that are used throughout this guide. Table 1. Text conventions Convention Description monospace Represents information as it [Device name]> appears on screen monospace bold Represents information that [Device name]> set you enter ipaddr 10.0.0.12 default font bold Keyboard keys, software buttons, and field names On the Start menu, click All Programs. italics Screen or page names Click Advanced Settings. The Advanced Settings page appears. Table 2. Example Notice conventions Notice Type Description NOTE Information that describes important features or instructions CAUTION! Information that alerts you to potential loss of data or potential damage to an application, system, or device WARNING! Information that alerts you to potential personal injury Terminology Table 3 lists the terms used in this guide. Table 3. Terms used in this guide Terms Description AP Access Point CP Captive Portal NBI Northbound Interface RADIUS Remote Authentication Dial-Up Service SCG Smart Cell Gateway SSL Secure Socket Layer SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 6 About This Guide Related Documentation Table 3. Terms used in this guide Terms Description TCP Transmission Control Protocol UE User Equipment UE-IP User Equipment - IP Address UE-MAC User Equipment - MAC Address Related Documentation For a complete list of documents that accompany this release, refer to the Release Notes. Documentation Feedback Ruckus Wireless is interested in improving its documentation and welcomes your comments and suggestions. You can email your comments to Ruckus Wireless at: docs@ruckuswireless.com When contacting us, please include the following information: • Document title • Document part number (on the cover page) • Page number (if appropriate) For example: • Ruckus Wireless SmartCell Gateway 200 Administrator Guide (Release 2.5.1) • Part number: 800-70670-001 • Page 88 SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 7 RESTful Interface Server 1 In this chapter: • Overview • Host • Resource • URI • Security • Representation SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 8 RESTful Interface Server Overview Overview This reference guide describes the features provided by the SCG 200 RESTful Interface Server, as well as its internal design considerations. The SCG RESTful interface server is responsible for providing access to certain SCG resources, such that external clients (that pass authentication) can pull information by means of simple RESTful operations. Currently, only GET operation is supported. NOTE: A separate document describing the DB Importer Client Application (which makes use of this RESTful API) to retrieve and make that information persistent into the RDBMS will be made available later. NOTE: Refer to About This Guide chapter for conventions used in this guide. Host The SCG RESTful API is available from any SCG node, specifically control plane (SCG-CBlade) in a cluster. Resource The API defines the resources of certain core objects such as AP, AP radio, AP WLan, mobility zone, controlblade, as well as collections of these core objects. It also defines the data resources for accessing the statistics of the corresponding core objects, as well as events and alarms. NOTE: Additional resources, such as datablade, tunnel, user equipment is planned for future releases. URI There are multiple ways for accessing and querying each resource and, therefore, there is multiple URIs for each resource. The URI format is intuitive and the information is human-readable. Typically, the path is used to represent the resource. Query parameters are used to describe the query, whenever applicable. In this release, there are 25 different URIs, which are described in the chapter - REST APIs. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 9 RESTful Interface Server Security Security The SCG RESTful API is protected by the same security facility as the SCG Web interface. Therefore, the client must first pass authentication before any REST API access is allowed. In this release, only user accounts with super administrator role have REST access capability. To log on, the client can perform a HTTPS PUT operation towards the log on URI and pass a JSON object with the attributes of username and password. The client also has to provide the correct information for these corresponding fields. For example to logon, {“userName”:”admin”, “password”:””user12#”} can be: URI HTTPS: https://SCG_Management_IP: 8443/wsg/api/scg/session/login Curl Command curl -k -i -H "Accept: application/json" -H "Content-type: application/json" -H "GMTOffset:12" -H "TimezoneOffset: 12" -c cookies.txt -X PUT -d '{"userName":"admin", "password":"admin123!"}' https://10.150.0.40:8443/wsg/ api/scg/session/login Example HTTP/1.1 200 OK Server: Apache-Coyote/1.1 Set-Cookie: JSESSIONID=C116A5694435A1963B4FD791BDACD34D; Path=/wsg; Secure Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Date: Sat, 14 Dec 2013 03:02:22 GMT Representation The response information is represented in JSON format, and is passed back to the client through HTTPS. The system supports multiple representations, since single data representation is not ideal for every client. It is only natural that in future, more SCG customers may require support of other formats such as XML, Atom, etc. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 10 REST APIs 2 This chapter lists the following REST APIs: • GET All Access Points • GET One Access Point • GET All Radio Records of One Access Point • GET One Radio Record of One Access Point • GET All Radio Records of All Access Points • GET All WLAN Records of One Access Point • GET One WLAN Record of One Access Point • GET All WLAN Records of All Access Points • GET All Mobility Zones • GET One Mobility Zone • GET All Controlblades • GET One Controlblade • GET All Statistics Between Start and End Time for One Access Point • GET All Statistics Between Start and End Time for All Radios of One Access Point • GET All Statistics Between Start and End Time for One Radio of One Access Point • GET All Statistics Between Start and End Time for All WLANs of One Access Point • GET All Statistics Between Start and End Time for One WLAN of One Access Point • GET All Statistics Between Start and End Time for All Mobility Zones • GET All Statistics Between Start and End Time for One Mobility Zone • GET All Statistics Between Start and End Time for All Controlblades • GET All Statistics Between Start and End time for One Controlblade • GET All Events Between Start and End Time • GET All Alarms Between Start and End Time SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 11 REST APIs GET All Access Points GET All Access Points This resource URI retrieves a list of all access point records from the SCG. URI ~/api/rest/aps Verb GET Parameters N/A Request Example https://SCG_Management_IP:8443/wsg/api/rest/aps Response Lists the access point records in JSON format Example { "aps": [ { "apMac": "C0:C5:20:26:95:D0", "serial": "101102000507", "model": "ZF7025", "deviceName": "RuckusAP", "description": null, "bladeId": "a30429f2-5f94-46aa-8068-d88d72e95896", "mobilityZoneUUID": "11a87f70-fada-4938-9fcba26edb1504d0", "lastSeen": 1364895872029, "uptime": 303, "ip": "192.168.0.101", "hops": 0, "fwVersion": "2.1.0.0.31", "gpsInfo": "", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 12 REST APIs GET One Access Point "gpsSource": null, "connectionStatus": "Disconnect", "registrationState": "1", "approvedTime": 1364895541135, "registrationTime": 1364895541135, } ] } GET One Access Point This resource URI retrieves a single access point record from the SCG based on the MAC address of the access point. URI ~/api/rest/ap/{macaddress} Verb GET Parameters • macaddress - MAC address of the access point Request Example : https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1 Response Lists the access point record in JSON format. Example: { "apMac": "00:22:68:00:00:A1", "serial": "101102000507", "model": "ZF7025", "deviceName": "RuckusAP", "description": null, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 13 REST APIs GET All Radio Records of One Access Point "bladeId": "a30429f2-5f94-46aa-8068-d88d72e95896", "mobilityZoneUUID": "11a87f70-fada-4938-9fcba26edb1504d0", "lastSeen": 1364895872029, "uptime": 303, "ip": "192.168.0.101", "hops": 0, "fwVersion": "2.1.0.0.31", "gpsInfo": "", "gpsSource": null, "connectionStatus": "Disconnect", "registrationState": "1", "approvedTime": 1364895541135, } GET All Radio Records of One Access Point This resource URI retrieves all radio records of a single access point from the SCG, using the MAC address of the access point. URI : ~/api/rest/ap/{macaddress}/radios Verb GET Parameters • macaddress - MAC address of the access point Request Example https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1/radios Response Lists the access point radio records in JSON format. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 14 REST APIs GET All Radio Records of One Access Point Example { "radios": [ { "apMac": "00:22:68:00:00:A1", "radioId": "0", "channel": "0", "mode": "11ng", "phyError": 0, "channelBlacklist": "", "channelList": null, "numOfAuthorizedClients": 0, "noiseFloor": -50, "rxBytes": 0, "rxFrames": 0, "txBytes": 0, "txFrames": 0, "retry": 33, "drop": 0, "rxMulticast": 0, "txMulticast": 0, } ] } { "radios": [ { "apMac": "8C:0C:90:02:F4:F0", "radioId": "1", "channel": "132", "mode": "11na", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 15 REST APIs GET All Radio Records of One Access Point "phyError": 66, "channelBlacklist": "", "channelList": null, "numOfAuthorizedClients": 0, "noiseFloor": -99, "rxBytes": 3213381, "rxFrames": 25709, "txBytes": 4827994, "txFrames": 28045, "retry": 1726, "drop": 0, "rxMulticast": 16252, "txMulticast": 0, "total": 0, "busy": 0, "rx": 0, "tx": 0, "backgroundScan": true, "txPower": "max", "channelWidth": 2, "clientCount": 0, "wlanGroupId": "87b24ac3-acd6-48d4-850f-21c837d53d50", "wlanGroupName": "default", "deployedWlanNum": 0, "maxWlanNum": 0, "wlanGroupWlanNum": 0, "key": "8C:0C:90:02:F4:F0_1", "columns": { "total": "0", "wlanGroupId": "87b24ac3-acd6-48d4-850f-21c837d53d50", "drop": "0", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 16 REST APIs GET All Radio Records of One Access Point "busy": "0", "clientCount": "0", "mode": "11na", "channelBlacklist": "", "rxFrames": "25709", "channelWidth": "2", "radioId": "1", "txMulticast": "0", "wlanGroupName": "default", "txFrames": "28045", "txPower": "max", "rxMulticast": "16252", "txBytes": "4827994", "rxBytes": "3213381", "numOfAuthorizedClients": "0", "tx": "0", "noiseFloor": "-99", "backgroundScan": "true", "retry": "1726", "channel": "132", "apMac": "8C:0C:90:02:F4:F0", "rx": "0", "phyError": "66" } }, { "apMac": "8C:0C:90:02:F4:F0", "radioId": "0", "channel": "11", "mode": "11ng", "phyError": 440, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 17 REST APIs GET All Radio Records of One Access Point "channelBlacklist": "", "channelList": null, "numOfAuthorizedClients": 2, "noiseFloor": -88, "rxBytes": 15574519, "rxFrames": 197036, "txBytes": 309672593, "txFrames": 270885, "retry": 73504, "drop": 0, "rxMulticast": 10701, "txMulticast": 0, "total": 78, "busy": 22, "rx": 53, "tx": 4, "backgroundScan": true, "txPower": "max", "channelWidth": 0, "clientCount": 2, "wlanGroupId": "87b24ac3-acd6-48d4-850f-21c837d53d50", "wlanGroupName": "default", "deployedWlanNum": 0, "maxWlanNum": 0, "wlanGroupWlanNum": 0, "key": "8C:0C:90:02:F4:F0_0", "columns": { "total": "78", "wlanGroupId": "87b24ac3-acd6-48d4-850f-21c837d53d50", "drop": "0", "busy": "22", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 18 REST APIs GET All Radio Records of One Access Point "clientCount": "2", "mode": "11ng", "channelBlacklist": "", "rxFrames": "197036", "channelWidth": "0", "radioId": "0", "txMulticast": "0", "wlanGroupName": "default", "txFrames": "270885", "txPower": "max", "rxMulticast": "10701", "txBytes": "309672593", "rxBytes": "15574519", "numOfAuthorizedClients": "2", "tx": "4", "noiseFloor": "-88", "backgroundScan": "true", "retry": "73504", "channel": "11", "apMac": "8C:0C:90:02:F4:F0", "rx": "53", "phyError": "440" } } ] } SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 19 REST APIs GET One Radio Record of One Access Point GET One Radio Record of One Access Point This resource URI retrieves a specific radio record of a single access point from the SCG, based on the MAC address and radio ID of the access point. URI ~/api/rest/ap/{macaddress}/radio/{radioid} Verb GET Parameters • macaddress - MAC address of the access point • radioid - Radio ID, for example - 0 or 1 Request Example https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1/radio/0 Response Specifies the AP radio record in JSON format. Example { "apMac": "00:22:68:00:00:A1", "radioId": "0", "channel": "0", "mode": "11ng", "phyError": 0, "channelBlacklist": "", "channelList": null, "numOfAuthorizedClients": null, "noiseFloor": -50, "rxBytes": 0, "rxFrames": 0, "txBytes": 0, "txFrames": 0, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 20 REST APIs GET All Radio Records of All Access Points "retry": 33, "drop": 0, "rxMulticast": 0, "txMulticast": 0, } GET All Radio Records of All Access Points This resource URI retrieves a list of all radio records for all access points that are managed by the SCG. URI ~/api/rest/aps/radios Verb GET Parameters N/A Request Example https://SCG_Management_IP:8443/wsg/api/rest/aps/radios Response Lists the AP radios records in JSON format. Example { "radios": [ { "apMac": "C0:C5:20:26:95:D0", "radioId": "0", "channel": "0", "mode": "11ng", "phyError": 0, "channelBlacklist": "", "channelList": null, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 21 REST APIs GET All Radio Records of All Access Points "numOfAuthorizedClients": null, "noiseFloor": -50, "rxBytes": 0, "rxFrames": 0, "txBytes": 0, "txFrames": 0, "retry": 33, "drop": 0, } ] } { "radios": [ { "apMac": "8C:0C:90:02:F4:F0", "radioId": "1", "channel": "132", "mode": "11na", "phyError": 66, "channelBlacklist": "", "channelList": null, "numOfAuthorizedClients": 0, "noiseFloor": -99, "rxBytes": 3213381, "rxFrames": 25709, "txBytes": 4827994, "txFrames": 28045, "retry": 1726, "drop": 0, "rxMulticast": 16252, "txMulticast": 0, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 22 REST APIs GET All Radio Records of All Access Points "total": 0, "busy": 0, "rx": 0, "tx": 0, "backgroundScan": true, "txPower": "max", "channelWidth": 2, "clientCount": 0, "wlanGroupId": "87b24ac3-acd6-48d4-850f-21c837d53d50", "wlanGroupName": "default", "deployedWlanNum": 0, "maxWlanNum": 0, "wlanGroupWlanNum": 0, "key": "8C:0C:90:02:F4:F0_1", "columns": { "total": "0", "wlanGroupId": "87b24ac3-acd6-48d4-850f-21c837d53d50", "drop": "0", "busy": "0", "clientCount": "0", "mode": "11na", "channelBlacklist": "", "rxFrames": "25709", "channelWidth": "2", "radioId": "1", "txMulticast": "0", "wlanGroupName": "default", "txFrames": "28045", "txPower": "max", "rxMulticast": "16252", "txBytes": "4827994", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 23 REST APIs GET All Radio Records of All Access Points "rxBytes": "3213381", "numOfAuthorizedClients": "0", "tx": "0", "noiseFloor": "-99", "backgroundScan": "true", "retry": "1726", "channel": "132", "apMac": "8C:0C:90:02:F4:F0", "rx": "0", "phyError": "66" } }, { "apMac": "8C:0C:90:02:F4:F0", "radioId": "0", "channel": "11", "mode": "11ng", "phyError": 440, "channelBlacklist": "", "channelList": null, "numOfAuthorizedClients": 2, "noiseFloor": -88, "rxBytes": 15574519, "rxFrames": 197036, "txBytes": 309672593, "txFrames": 270885, "retry": 73504, "drop": 0, "rxMulticast": 10701, "txMulticast": 0, "total": 78, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 24 REST APIs GET All Radio Records of All Access Points "busy": 22, "rx": 53, "tx": 4, "backgroundScan": true, "txPower": "max", "channelWidth": 0, "clientCount": 2, "wlanGroupId": "87b24ac3-acd6-48d4-850f-21c837d53d50", "wlanGroupName": "default", "deployedWlanNum": 0, "maxWlanNum": 0, "wlanGroupWlanNum": 0, "key": "8C:0C:90:02:F4:F0_0", "columns": { "total": "78", "wlanGroupId": "87b24ac3-acd6-48d4-850f-21c837d53d50", "drop": "0", "busy": "22", "clientCount": "2", "mode": "11ng", "channelBlacklist": "", "rxFrames": "197036", "channelWidth": "0", "radioId": "0", "txMulticast": "0", "wlanGroupName": "default", "txFrames": "270885", "txPower": "max", "rxMulticast": "10701", "txBytes": "309672593", "rxBytes": "15574519", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 25 REST APIs GET All WLAN Records of One Access Point "numOfAuthorizedClients": "2", "tx": "4", "noiseFloor": "-88", "backgroundScan": "true", "retry": "73504", "channel": "11", "apMac": "8C:0C:90:02:F4:F0", "rx": "53", "phyError": "440" } } ] } GET All WLAN Records of One Access Point This resource URI retrieves all WLAN records of a single access point, which is managed by the SCG, based on the MAC address of the access point. URI ~/api/rest/ap/{macaddress}/wlans Verb GET Parameters • macaddress - MAC address of the access point Request Example https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1/wlans Response Lists the AP WLAN records in JSON format. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 26 REST APIs GET All WLAN Records of One Access Point Example { "wlans": [ { "key": "C0:C5:20:26:95:D8", "bssid": "C0:C5:20:26:95:D8", "apMac": "00:22:68:00:00:A1", "radioId": "0", "radioType": null, "rxBytes": "2208536", "ssid": "kkkwlan1", "totalNumClients": "0", "txBytes": "19761", "wlanId": "0", "authmethod": "NONE", "wsgWlanId": "1", "columns": { } ] } { "wlans": [ { "key": "8C:0C:90:82:F4:F8", "bssid": "8C:0C:90:82:F4:F8", "apMac": "8C:0C:90:02:F4:F0", "radioId": "0", "radioType": null, "rxBytes": "111408", "ssid": "w3", "totalNumClients": "0", "txBytes": "648", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 27 REST APIs GET All WLAN Records of One Access Point "wlanId": "2", "authmethod": "OPEN", "wsgWlanId": "3", "columns": { "wsgWlanId": "3", "bssid": "8C:0C:90:82:F4:F8", "authmethod": "OPEN", "totalNumClients": "0", "wlanId": "2", "radioId": "0", "ssid": "w3", "txBytes": "648", "rxBytes": "111408", "apMac": "8C:0C:90:02:F4:F0" } }, { "key": "8C:0C:90:42:F4:F8", "bssid": "8C:0C:90:42:F4:F8", "apMac": "8C:0C:90:02:F4:F0", "radioId": "0", "radioType": null, "rxBytes": "120535", "ssid": "w2", "totalNumClients": "0", "txBytes": "2592", "wlanId": "1", "authmethod": "OPEN", "wsgWlanId": "2", "columns": { "wsgWlanId": "2", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 28 REST APIs GET All WLAN Records of One Access Point "bssid": "8C:0C:90:42:F4:F8", "authmethod": "OPEN", "totalNumClients": "0", "wlanId": "1", "radioId": "0", "ssid": "w2", "txBytes": "2592", "rxBytes": "120535", "apMac": "8C:0C:90:02:F4:F0" } }, { "key": "8C:0C:90:02:F4:F8", "bssid": "8C:0C:90:02:F4:F8", "apMac": "8C:0C:90:02:F4:F0", "radioId": "0", "radioType": null, "rxBytes": "11493936237", "ssid": "w21", "totalNumClients": "2", "txBytes": "338023205", "wlanId": "0", "authmethod": "OPEN", "wsgWlanId": "1", "columns": { "wsgWlanId": "1", "bssid": "8C:0C:90:02:F4:F8", "authmethod": "OPEN", "totalNumClients": "2", "wlanId": "0", "radioId": "0", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 29 REST APIs GET All WLAN Records of One Access Point "ssid": "w21", "txBytes": "338023205", "rxBytes": "11493936237", "apMac": "8C:0C:90:02:F4:F0" } }, { "key": "8C:0C:90:02:F4:FC", "bssid": "8C:0C:90:02:F4:FC", "apMac": "8C:0C:90:02:F4:F0", "radioId": "1", "radioType": null, "rxBytes": "476104347", "ssid": "w21", "totalNumClients": "0", "txBytes": "36246953", "wlanId": "32", "authmethod": "OPEN", "wsgWlanId": "1", "columns": { "wsgWlanId": "1", "bssid": "8C:0C:90:02:F4:FC", "authmethod": "OPEN", "totalNumClients": "0", "wlanId": "32", "radioId": "1", "ssid": "w21", "txBytes": "36246953", "rxBytes": "476104347", "apMac": "8C:0C:90:02:F4:F0" } SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 30 REST APIs GET All WLAN Records of One Access Point }, { "key": "8C:0C:90:42:F4:FC", "bssid": "8C:0C:90:42:F4:FC", "apMac": "8C:0C:90:02:F4:F0", "radioId": "1", "radioType": null, "rxBytes": "10116", "ssid": "w2", "totalNumClients": "0", "txBytes": "908", "wlanId": "33", "authmethod": "OPEN", "wsgWlanId": "2", "columns": { "wsgWlanId": "2", "bssid": "8C:0C:90:42:F4:FC", "authmethod": "OPEN", "totalNumClients": "0", "wlanId": "33", "radioId": "1", "ssid": "w2", "txBytes": "908", "rxBytes": "10116", "apMac": "8C:0C:90:02:F4:F0" } }, { "key": "8C:0C:90:82:F4:FC", "bssid": "8C:0C:90:82:F4:FC", "apMac": "8C:0C:90:02:F4:F0", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 31 REST APIs GET All WLAN Records of One Access Point "radioId": "1", "radioType": null, "rxBytes": "7998", "ssid": "w3", "totalNumClients": "0", "txBytes": "0", "wlanId": "34", "authmethod": "OPEN", "wsgWlanId": "3", "columns": { "wsgWlanId": "3", "bssid": "8C:0C:90:82:F4:FC", "authmethod": "OPEN", "totalNumClients": "0", "wlanId": "34", "radioId": "1", "ssid": "w3", "txBytes": "0", "rxBytes": "7998", "apMac": "8C:0C:90:02:F4:F0" } } ] } SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 32 REST APIs GET One WLAN Record of One Access Point GET One WLAN Record of One Access Point This resource URI retrieves a specific WLAN record of a single access point, based on its MAC address and WLAN ID. URI ~/api/rest/ap/{macaddress}/wlan/{wlanid} Verb GET Parameters • macaddress - MAC address of the access point • wlanid - WLAN ID, for example, 0 or 1 Request Example https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1/wlan/0 Response Lists the specific AP WLAN record in JSON format. Example { "key": "C0:C5:20:26:95:D8", "bssid": "C0:C5:20:26:95:D8", "apMac": "00:22:68:00:00:A1", "radioId": "0", "radioType": null, "rxBytes": "2208536", "ssid": "kkkwlan1", "totalNumClients": "0", "txBytes": "19761", "wlanId": "0", "authmethod": "NONE", "wsgWlanId": "1", "columns":{ SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 33 REST APIs GET All WLAN Records of All Access Points } GET All WLAN Records of All Access Points This resource URI retrieves a list of all WLAN records for all access points managed by the SCG. URI ~/api/rest/aps/wlans Verb GET Parameters N/A Request Example https://SCG_Management_IP:8443/wsg/api/rest/aps/wlans Response Lists theAP WLAN records in JSON format. Example { "wlans": [ { "key": "C0:C5:20:26:95:D8", "bssid": "C0:C5:20:26:95:D8", "apMac": "C0:C5:20:26:95:D0", "radioId": "0", "radioType": null, "rxBytes": "2208536", "ssid": "kkkwlan1", "totalNumClients": "0", "txBytes": "19761", "wlanId": "0", "authmethod": null, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 34 REST APIs GET All WLAN Records of All Access Points "wsgWlanId": "1", "columns": { "bssid": "C0:C5:20:26:95:D8", "wsgWlanId": "1", "totalNumClients": "0" } } ] } { "wlans": [ { "key": "8C:0C:90:05:87:BC", "bssid": "8C:0C:90:05:87:BC", "apMac": "8C:0C:90:05:87:B0", "radioId": "1", "radioType": null, "rxBytes": "86340", "ssid": "w21", "totalNumClients": "0", "txBytes": "19477", "wlanId": "32", "authmethod": null, "wsgWlanId": "1", "columns": { "wsgWlanId": "1", "bssid": "8C:0C:90:05:87:BC", "totalNumClients": "0", "wlanId": "32", "radioId": "1", "ssid": "w21", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 35 REST APIs GET All WLAN Records of All Access Points "txBytes": "19477", "rxBytes": "86340", "apMac": "8C:0C:90:05:87:B0" } }, { "key": "8C:0C:90:42:F4:FC", "bssid": "8C:0C:90:42:F4:FC", "apMac": "8C:0C:90:02:F4:F0", "radioId": "1", "radioType": null, "rxBytes": "2367996", "ssid": "w2", "totalNumClients": "0", "txBytes": "130752", "wlanId": "33", "authmethod": null, "wsgWlanId": "2", "columns": { "wsgWlanId": "2", "bssid": "8C:0C:90:42:F4:FC", "totalNumClients": "0", "wlanId": "33", "radioId": "1", "ssid": "w2", "txBytes": "130752", "rxBytes": "2367996", "apMac": "8C:0C:90:02:F4:F0" } }, { SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 36 REST APIs GET All WLAN Records of All Access Points "key": "8C:0C:90:82:F4:FC", "bssid": "8C:0C:90:82:F4:FC", "apMac": "8C:0C:90:02:F4:F0", "radioId": "1", "radioType": null, "rxBytes": "2365878", "ssid": "w3", "totalNumClients": "0", "txBytes": "129844", "wlanId": "34", "authmethod": null, "wsgWlanId": "3", "columns": { "wsgWlanId": "3", "bssid": "8C:0C:90:82:F4:FC", "totalNumClients": "0", "wlanId": "34", "radioId": "1", "ssid": "w3", "txBytes": "129844", "rxBytes": "2365878", "apMac": "8C:0C:90:02:F4:F0" } }, { "key": "8C:0C:90:45:87:BC", "bssid": "8C:0C:90:45:87:BC", "apMac": "8C:0C:90:05:87:B0", "radioId": "1", "radioType": null, "rxBytes": "75718", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 37 REST APIs GET All WLAN Records of All Access Points "ssid": "w2", "totalNumClients": "0", "txBytes": "18387", "wlanId": "33", "authmethod": null, "wsgWlanId": "2", "columns": { "wsgWlanId": "2", "bssid": "8C:0C:90:45:87:BC", "totalNumClients": "0", "wlanId": "33", "radioId": "1", "ssid": "w2", "txBytes": "18387", "rxBytes": "75718", "apMac": "8C:0C:90:05:87:B0" } }, { "key": "8C:0C:90:85:87:B8", "bssid": "8C:0C:90:85:87:B8", "apMac": "8C:0C:90:05:87:B0", "radioId": "0", "radioType": null, "rxBytes": "2892711", "ssid": "w3", "totalNumClients": "0", "txBytes": "69552", "wlanId": "2", "authmethod": null, "wsgWlanId": "3", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 38 REST APIs GET All WLAN Records of All Access Points "columns": { "wsgWlanId": "3", "bssid": "8C:0C:90:85:87:B8", "totalNumClients": "0", "wlanId": "2", "radioId": "0", "ssid": "w3", "txBytes": "69552", "rxBytes": "2892711", "apMac": "8C:0C:90:05:87:B0" } }, { "key": "8C:0C:90:05:87:B8", "bssid": "8C:0C:90:05:87:B8", "apMac": "8C:0C:90:05:87:B0", "radioId": "0", "radioType": null, "rxBytes": "2895895", "ssid": "w21", "totalNumClients": "0", "txBytes": "72689", "wlanId": "0", "authmethod": null, "wsgWlanId": "1", "columns": { "wsgWlanId": "1", "bssid": "8C:0C:90:05:87:B8", "totalNumClients": "0", "wlanId": "0", "radioId": "0", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 39 REST APIs GET All WLAN Records of All Access Points "ssid": "w21", "txBytes": "72689", "rxBytes": "2895895", "apMac": "8C:0C:90:05:87:B0" } }, { "key": "8C:0C:90:45:87:B8", "bssid": "8C:0C:90:45:87:B8", "apMac": "8C:0C:90:05:87:B0", "radioId": "0", "radioType": null, "rxBytes": "2894169", "ssid": "w2", "totalNumClients": "0", "txBytes": "69552", "wlanId": "1", "authmethod": null, "wsgWlanId": "2", "columns": { "wsgWlanId": "2", "bssid": "8C:0C:90:45:87:B8", "totalNumClients": "0", "wlanId": "1", "radioId": "0", "ssid": "w2", "txBytes": "69552", "rxBytes": "2894169", "apMac": "8C:0C:90:05:87:B0" } }, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 40 REST APIs GET All WLAN Records of All Access Points { "key": "8C:0C:90:02:F4:F8", "bssid": "8C:0C:90:02:F4:F8", "apMac": "8C:0C:90:02:F4:F0", "radioId": "0", "radioType": null, "rxBytes": "11543828139", "ssid": "w21", "totalNumClients": "1", "txBytes": "338349994", "wlanId": "0", "authmethod": null, "wsgWlanId": "1", "columns": { "wsgWlanId": "1", "bssid": "8C:0C:90:02:F4:F8", "totalNumClients": "1", "wlanId": "0", "radioId": "0", "ssid": "w21", "txBytes": "338349994", "rxBytes": "11543828139", "apMac": "8C:0C:90:02:F4:F0" } }, { "key": "8C:0C:90:82:F4:F8", "bssid": "8C:0C:90:82:F4:F8", "apMac": "8C:0C:90:02:F4:F0", "radioId": "0", "radioType": null, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 41 REST APIs GET All WLAN Records of All Access Points "rxBytes": "49943881", "ssid": "w3", "totalNumClients": "0", "txBytes": "282096", "wlanId": "2", "authmethod": null, "wsgWlanId": "3", "columns": { "wsgWlanId": "3", "bssid": "8C:0C:90:82:F4:F8", "totalNumClients": "0", "wlanId": "2", "radioId": "0", "ssid": "w3", "txBytes": "282096", "rxBytes": "49943881", "apMac": "8C:0C:90:02:F4:F0" } }, { "key": "8C:0C:90:85:87:BC", "bssid": "8C:0C:90:85:87:BC", "apMac": "8C:0C:90:05:87:B0", "radioId": "1", "radioType": null, "rxBytes": "75387", "ssid": "w3", "totalNumClients": "0", "txBytes": "18387", "wlanId": "34", "authmethod": null, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 42 REST APIs GET All WLAN Records of All Access Points "wsgWlanId": "3", "columns": { "wsgWlanId": "3", "bssid": "8C:0C:90:85:87:BC", "totalNumClients": "0", "wlanId": "34", "radioId": "1", "ssid": "w3", "txBytes": "18387", "rxBytes": "75387", "apMac": "8C:0C:90:05:87:B0" } }, { "key": "8C:0C:90:02:F4:FC", "bssid": "8C:0C:90:02:F4:FC", "apMac": "8C:0C:90:02:F4:F0", "radioId": "1", "radioType": null, "rxBytes": "478493255", "ssid": "w21", "totalNumClients": "0", "txBytes": "36381500", "wlanId": "32", "authmethod": null, "wsgWlanId": "1", "columns": { "wsgWlanId": "1", "bssid": "8C:0C:90:02:F4:FC", "totalNumClients": "0", "wlanId": "32", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 43 REST APIs GET All WLAN Records of All Access Points "radioId": "1", "ssid": "w21", "txBytes": "36381500", "rxBytes": "478493255", "apMac": "8C:0C:90:02:F4:F0" } }, { "key": "8C:0C:90:42:F4:F8", "bssid": "8C:0C:90:42:F4:F8", "apMac": "8C:0C:90:02:F4:F0", "radioId": "0", "radioType": null, "rxBytes": "49953268", "ssid": "w2", "totalNumClients": "0", "txBytes": "284040", "wlanId": "1", "authmethod": null, "wsgWlanId": "2", "columns": { "wsgWlanId": "2", "bssid": "8C:0C:90:42:F4:F8", "totalNumClients": "0", "wlanId": "1", "radioId": "0", "ssid": "w2", "txBytes": "284040", "rxBytes": "49953268", "apMac": "8C:0C:90:02:F4:F0" } SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 44 REST APIs GET All Mobility Zones } ] } GET All Mobility Zones This resource URI retrieves a list of all mobility zone records from SCG. URI ~/api/rest/mobilityzones Verb GET Parameters N/A Request Example https://SCG_Management_IP:8443/wsg/api/rest/mobilityzones Response Lists the mobility zone records in JSON format. Example { "mobilityzones": [ { "key": "b4187899-38ae-4ace-8e40-0bc444455156", "mobilityZoneName": "Staging Zone", "description": "Staging Zone", "meshSSID": null, "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25", "createDatetime": 1363766599388, "fwMaxRebootWait": null, "switchoverCluster": null, "switchoverClusterEnable": false, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 45 REST APIs GET One Mobility Zone "domainUUID": null, "columns": { "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25", "mobilityZoneName": "Staging Zone", "description": "Staging Zone”, } } ] } GET One Mobility Zone This resource URI retrieves one mobility zone record from the SCG, based on the zone UUID. URI ~/api/rest/mobilityzone/{zoneuuid} Verb GET Parameters • zoneuuid - Zone UUID Request Example https://SCG_Management_IP:8443/wsg/api/rest/mobilityzone/ cee71896-241e-4fbf-a3e2-62cb47d63573 Response Lists the mobility zone record in JSON format. Example Key is the {zoneuuid} { "key": "cee71896-241e-4fbf-a3e2-62cb47d63573", "mobilityZoneName": "zone1", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 46 REST APIs GET All Controlblades "description": "", "meshSSID": null, "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25", "createDatetime": 1364362756320, "fwMaxRebootWait": null, "switchoverCluster": null, "switchoverClusterEnable": false, "domainUUID": null, "columns": { "creatorUUID": "92cc1b65-c3cd-4f26-8c9b-3e7b055c7c25", "mobilityZoneName": "zone1", "description": "", } } GET All Controlblades This resource URI retrieves a list of all controlblade records from the SCG. URI ~/api/rest/controlblades Verb GET Parameters N/A Request Example https://SCG_Management_IP:8443/wsg/api/rest/controlblades Response Lists the controlblade records in JSON format. Example { "controlBlades": [ SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 47 REST APIs GET One Controlblade { "key": "a30429f2-5f94-46aa-8068-d88d72e95896", "healthEnum": "Online", "bladeStateEnum": "In_Service", "description": "ctrldesc112", "statistics": null, "hostName": "cblade", "mac": "00:00:00:00:00:00", "ip": "172.18.114.61", "firmware": null, "model": "SCG112020", "serialNumber": "000000112020", "removalStatus": null, "start-time": 1364894071654, "role": null, "bindingIps": { "br2": "172.18.114.63", "br1": "172.18.114.61", } } ] } GET One Controlblade This resource URI retrieves one controlblade record from SCG, based on the zone UUID. URI ~/api/rest/controlblade/{bladeuuid} Verb GET SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 48 REST APIs GET One Controlblade Parameters • bladeuuid - Blade UUID Request Example https://SCG_Management_IP:8443/wsg/api/rest/controlblade/ 380d2ff8-dfde-46c2-85cd- 493ed5b7b920 Response Lists the controlblade record in JSON format. Example Key is the {bladeuuid} { "key": "a30429f2-5f94-46aa-8068-d88d72e95896", "healthEnum": "Online", "bladeStateEnum": "In_Service", "description": "ctrldesc112", "statistics": null, "hostName": "cblade", "mac": "00:00:00:00:00:00", "ip": "172.18.114.61", "firmware": null, "model": "SCG112020", "serialNumber": "000000112020", "removalStatus": null, "start-time": 1364894071654, "role": null, "bindingIps": { "br2": "172.18.114.63", "br1": "172.18.114.61", "br0": "172.18.114.60", } } SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 49 REST APIs GET All Statistics Between Start and End Time for One Access Point GET All Statistics Between Start and End Time for One Access Point This resource URI retrieves statistical records between the specified start and end time of one access point from SCG, based on MAC address. of the access point. URI ~/api/rest/ap/{macaddress}/stats?starttime={startTime}&endtime={endTime} Verb GET Parameters • macaddress - MAC address of the access point • start-Time - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. Request Example https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1/stats?starttime=2011-12-31%2023:59:59%20pst&endtime=2012-0108%2000:00:00%20pst Response Lists the AP statistical records in JSON format. Example { "apstats": [ { "macAddress": "00:22:68:00:00:A1", "timestamp": 1364905800000, "txBytes": 0, "rxBytes": 0, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 50 REST APIs GET All Statistics Between Start and End Time for All Radios of One Access Point "airtime": 0, "minNumClients": 0, "txRateKbps": 0, "rxRateKbps": 0, "rxDataFrames": 0, "uptime": null, "avgNumClients": 0, "txDataFrames": 0, } ] } GET All Statistics Between Start and End Time for All Radios of One Access Point This resource URI retrieves statistical records between the specified start and end time of all radios on one access point from the SCG. This is based on the MAC addressof the access point. URI ~/api/rest/ap/{macaddress}/radios/stats?starttime={startTime}&endtime={endTime} Verb GET Parameters • macaddress - MAC address of the access point • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 51 REST APIs GET All Statistics Between Start and End Time for All Radios of One Access Point Request Example https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1/radios/stats?start-time=2011-1231%2023:59:59%20pst&endtime=2012-01-08%2000:00:00%20pst Response Lists the AP radio statistical records in JSON format. Example { "apradioStats": [ { "macAddress": "00:22:68:00:00:A1", "radioId": "0", "timestamp": 1364905800000, "num11nClients": 0, "txFrames": null, "airtime": 0, "rxBytes": null, "minNumClients": 0, "rxFrames": null, "txBytes": null, "numNon11nClients": 0, "maxNumClients": 0 } { "macAddress": "00:22:68:00:00:A1", "radioId": "0", "timestamp": 1364906700000, "num11nClients": 0, "txFrames": null, "airtime": 65, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 52 REST APIs GET All Statistics Between Start and End Time for One Radio of One Access Point } ] } GET All Statistics Between Start and End Time for One Radio of One Access Point This resource URI retrieves statistical records between the input start and end time for all radios of one access point from SCG. This is based on the MAC address of access points. URI ~/api/rest/ap/{macaddress}/radio/{radioid}/stats?starttime={start-Time}&endtime={endTime} Verb GET Parameters • macaddress - MAC address of the access point • radioid - Radio ID, for example - 0 or 1 • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. Request Example https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1/radio/0/stats?start-time=2011-1231%2023:59:59%20pst&endtime=2012-01-08%2000:00:00%20pst Response Lists the AP radio statistical records in JSON format. Example { "apradioStats": [ SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 53 REST APIs GET All Statistics Between Start and End Time for All WLANs of One Access Point { "macAddress": "00:22:68:00:00:A1", "radioId": "0", "timestamp": 1364905800000, "num11nClients": 0, "txFrames": null, "airtime": 0, "rxBytes": null, "minNumClients": 0, "rxFrames": null, "txBytes": null, "numNon11nClients": 0, "maxNumClients": 0 } { "macAddress": "00:22:68:00:00:A1", "radioId": "0", "timestamp": 1364906700000, "num11nClients": 0, "txFrames": null, "airtime": 65, } ] } GET All Statistics Between Start and End Time for All WLANs of One Access Point This resource URI retrieves statistical records between the specified start and end time for all WLANs on one access point from the SCG. This is based, on the MAC address of access points. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 54 REST APIs GET All Statistics Between Start and End Time for All WLANs of One Access Point URI ~/api/rest/ap/{macaddress}/wlans/stats?starttime={startTime}&endtime={endTime} Verb GET Parameters • macaddress - MAC address of the access point • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. Request Example https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1/wlans/stats?start-time=2011-1231%2023:59:59%20pst&endtime=2012-01-08%2000:00:00%20pst Response Lists the AP WLAN statistical records in JSON format. Example { "apwlanStats": [ { "macAddress": "00:22:68:00:00:A1", "timestamp": 1364906700000, "radioId": "0", "wlanId": "0", "ssid": "kkkwlan1", "bssid": "c0:c5:20:26:95:d8", "txBytes": null, "rxBytes": null, "txRateKbps": 0, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 55 REST APIs GET All Statistics Between Start and End Time for One WLAN of One Access Point "rxRateKbps": 0, "minNumClients": 0, "avgNumClients": 0, "maxNumClients": 0 } { "macAddress": "00:22:68:00:00:A1", "timestamp": 1364907600000, "radioId": "0", "wlanId": "0", } ] } GET All Statistics Between Start and End Time for One WLAN of One Access Point This resource URI retrieves statistical records between the specified start and end time for one WLAN pertaining to one access point from the SCG. This is based on the MAC address and WLAN ID, respectively. URI ~/api/rest/ap/{macaddress}/wlan/{wlanid}/stats?starttime={start-Time}&endtime={endTime} Verb GET Parameters • macaddress - MAC address of the access point • wlanid - WLAN ID, for example - 0,1 • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 56 REST APIs GET All Statistics Between Start and End Time for One WLAN of One Access Point Request Example https://SCG_Management_IP:8443/wsg/api/rest/ap/ 00:22:68:00:00:A1/wlan/0/stats?start-time=2011-1231%2023:59:59%20pst&endtime=2012-01-08%2000:00:00%20pst Response Lists the AP WLAN statistical records in JSON format. Example { "apwlanStats": [ { "macAddress": "00:22:68:00:00:A1", "timestamp": 1364906700000, "radioId": "0", "wlanId": "0", "ssid": "kkkwlan1", "bssid": "c0:c5:20:26:95:d8", "txBytes": null, "rxBytes": null, "txRateKbps": 0, "rxRateKbps": 0, "minNumClients": 0, } ] } SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 57 REST APIs GET All Statistics Between Start and End Time for All Mobility Zones GET All Statistics Between Start and End Time for All Mobility Zones This resource URI retrieves statistical records between the specified start and end time for all mobility zones from the SCG. URI ~/api/rest/mobilityzones/stats?starttime={startTime}&endtime={endTime} Verb GET Parameters • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. Request Example https://SCG_Management_IP:8443/wsg/api/rest/mobilityzones/ stats?start-time=2011-12-31%2023:59:59%20pst&endtime=201201-08%2000:00:00%20pst Response Lists the mobility zone statistical records in JSON format. Example { "mobilityZoneStats": [ { "zoneUUID": "11a87f70-fada-4938-9fcb-a26edb1504d0", "timestamp": 1364905800000, "txBytes": 0, "rxBytes": 0, "airtime": 0, "minNumClients": 0, "txRateKbps": 0, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 58 REST APIs GET All Statistics Between Start and End Time for One Mobility Zone "rxRateKbps": 0, "rxDataFrames": 0, "uptime": null, "avgNumClients": 0, "txDataFrames": 0, "maxNumClients": 0 } { "zoneUUID": "11a87f70-fada-4938-9fcb-a26edb1504d0", "timestamp": 1364906700000, "txBytes": 0, } ] } GET All Statistics Between Start and End Time for One Mobility Zone This resource URI retrieves statistical records between the specified start and end time for one mobility zone from the SCG, based on the Zone UUID. URI ~/api/rest/mobilityzone/{zoneuuid}/stats?starttime={startTime}&endtime={endTime} Verb GET Parameters • zoneuuid - Zone UUID • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 59 REST APIs GET All Statistics Between Start and End Time for All Controlblades Request Example https://SCG_Management_IP:8443/wsg/api/rest/mobilityzone/ cee71896-241e-4fbf-a3e2-62cb47d63573/stats?starttime=2011-12-31%2023:59:59%20pst&endtime=2012-0108%2000:00:00%20pst Response Lists the mobility zone statistical records in JSON format. Example { "mobilityZoneStats": [ { "zoneUUID": "cee71896-241e-4fbf-a3e2-62cb47d63573", "timestamp": 1364905800000, "txBytes": 0, "rxBytes": 0, "airtime": 0, "minNumClients": 0, "txRateKbps": 0, "rxRateKbps": 0, "rxDataFrames": 0, "uptime": null, } ] } GET All Statistics Between Start and End Time for All Controlblades This resource URI retrieves statistical records between the specified start and end time for all controlblades from the SCG. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 60 REST APIs GET All Statistics Between Start and End Time for All Controlblades NOTE: The statistical data of controlblade is available only for 2 days. RESTful API can retrieve only the last two days of the controlblade statistical data from the SCG. Access to older data will not return any values. URI ~/api/rest/controlblades/stats?starttime={startTime}&endtime={endTime} Verb GET Parameters • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. Request Example https://SCG_Management_IP:8443/wsg/api/rest/controlblades/ stats?start-time=2011-12-31%2023:59:59%20pst&endtime=201201-08%2000:00:00%20pst Response Lists the controlblade statistical records in JSON format. Example { "controlBladeStats": [ { "bladeUUID": "a30429f2-5f94-46aa-8068-d88d72e95896", "timestamp": 1364787600000, "cpu_perc": null, "cpu_perc_min": null, "cpu_perc_max": null, "memory_perc": null, "memory_perc_min": null, "memory_perc_max": null SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 61 REST APIs GET All Statistics Between Start and End time for One Controlblade } { "bladeUUID": "a30429f2-5f94-46aa-8068-d88d72e95896", "timestamp": 1364787900000, "cpu_perc": null, "cpu_perc_min": null, "cpu_perc_max": null, "memory_perc": null } ] } GET All Statistics Between Start and End time for One Controlblade This resource URI retrieves statistical records between the specified start and end time of a single controlblade from the SCG. This is based on the Zone UUID. NOTE: The statistical data of controlblade is available only for 2 days. RESTful API can retrieve only the last two days of the controlblade statistical data from the SCG. Access to older data will not return any values. URI ~/api/rest/controlblade/{bladeuuid}/stats?starttime={start-Time}&endtime={endTime} Verb GET Parameters • bladeuuid - Blade UUID • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 62 REST APIs GET All Statistics Between Start and End time for One Controlblade Request Example https://SCG_Management_IP:8443/wsg/api/rest/controlblade/ 380d2ff8-dfde-46c2-85cd-493ed5b7b920/stats?starttime=2011-12-31%2023:59:59%20pst&endtime=2012-0108%2000:00:00%20pst Response Lists the controlblade statistical records in JSON format. Example { "controlBladeStats": [ { "bladeUUID": "380d2ff8-dfde-46c2-85cd-493ed5b7b920", "timestamp": 1364787600000, "cpu_perc": null, "cpu_perc_min": null, "cpu_perc_max": null, "memory_perc": null, "memory_perc_min": null, "memory_perc_max": null } { "bladeUUID": "380d2ff8-dfde-46c2-85cd-493ed5b7b920", "timestamp": 1364787900000, "cpu_perc": null, "cpu_perc_min": null, "cpu_perc_max": null, "memory_perc": null } ] } SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 63 REST APIs GET All Events Between Start and End Time GET All Events Between Start and End Time This resource URI retrieves event records between the specified start (including) and end time from the SCG using the attribute insertion time for comparison. URI ~/api/rest/events?starttime={startTime}&endtime={endTime} Verb GET Parameters • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. Request Example https://SCG_Management_IP:84433/wsg/api/rest/events?starttime=2011-12-31%2023:59:59%20pst&endtime=2012-0108%2000:00:00%20pst Response Lists event records in JSON format. Example { "events": [ { "ap": null, "eventCode": 826, "category": "Cluster", "severity": "Major", "zoneUUID": null, "eventType": "nodeRebooted", "model": null, "apMac": null, SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 64 REST APIs GET All Alarms Between Start and End Time "wsgIP": null, "configID": null, "timestamp": 1363766861123 } ] } GET All Alarms Between Start and End Time This resource URI retrieves alarm records between the specified start (including) and end time from the SCG using insertion time for comparison. URI ~/api/rest/alarms?starttime={startTime}&endtime={endTime} Verb GET Parameters • startTime - Start time format is - “yyyy-mm-dd hh:mi:ss timezone”. For example, “2011-12-10 11:22:33 pst” • endTime - End time format is similar to the start time format. Request Example https://SCG_Management_IP:8443/wsg/api/rest/alarms? starttime=2011-12-31%2023:59:59%20pst&endtime=2012-0108%2000:00:00%20pst Response Lists the alarm records in JSON format. Example { "alarms": [ { "key": "39246a08-6b96-4e54-a8c0-b2cb338acc17", SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 65 REST APIs GET All Alarms Between Start and End Time "alarmCode": 811, "alarmUUID": "39246a08-6b96-4e54-a8c0-b2cb338acc17", "ackUserUUID": null, "ackTimestamp": null, "timestamp": 1364356298241, "zoneUUID": null, "alarmType": "nodeRebooted", "alarmState": "Outstanding", "alarmSeverity": "Major", "acknowledged": "No", "clearEventCode": null, "all": "", "event": { "ap": null, "eventCode": 826, "category": "Cluster", "severity": "Major", "zoneUUID": null, } ] } { SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 66 Index A H alarms between start and end time 65 all access points 12 all controlblades 47 all events between start and end time 64 all mobility zones 45 all radio records of all access points 21 all radio records of one access point 14 all statistics for all controlblades 60 all statistics for all mobility zones 58 all statistics for all radios of one access point 51 all statistics for all WLans of one access point 54 all statistics for one access point 50 all statistics for one controlblade 62 all statistics for one mobility zone 59 all statistics for one radio of one access point 53 all statistics for one WLan of one access point 56 all WLan records of all access points 34 all WLan records of one access point 26 authentication 10 host 9 M macaddress 13, 14, 20, 26, 33, 50, 51, 53, 55, 56 multiple representations 10 O one access point 13 one controlblade 48 one mobility zone 46 one radio record of one access point 20 one WLan record of one access point 33 overview 9 P parameters 12, 13, 14, 20, 21, 26, 33, 34, 45, 46, 47, 49, 50, 51, 53, 55, 56, 58, 59, 61, 62, 64, 65 Q B query parameters 9 bladeuuid 49, 62 R C core objects 9 D data resources 9 E radioid 20, 53 representation 10 request example 12, 13, 14, 20, 21, 26, 33, 34, 45, 46, 47, 49, 50, 52, 53, 55, 57, 58, 60, 61, 63, 64, 65 resource 9 response 12, 13, 14, 20, 21, 26, 33, 34, 45, 46, 47, 49, 50, 52, 53, 55, 57, 58, 60, 61, 63, 64, 65 endTime 50, 51, 53, 55, 56, 58, 59, 61, 62, 64, 65 example 12, 13, 15, 20, 21, 27, 33, 34, 45, 46, 47, 49, 50, 52, 53, 55, 57, 58, 60, 61, 63, 64, 65 S security 10 security facility 10 start-Time 50 SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 67 Index startTime 51, 53, 55, 56, 58, 59, 61, 62, 64, 65 statistics 9 super administrator 10 U uRI 9, 10, 12, 13, 14, 20, 21, 26, 33, 34, 45, 46, 47, 48, 50, 51, 53, 55, 56, 58, 59, 61, 62, 64, 65 user accounts 10 V verb 12, 13, 14, 20, 21, 26, 33, 34, 45, 46, 47, 48, 50, 51, 53, 55, 56, 58, 59, 61, 62, 64, 65 W wlanid 33, 56 Z zoneuuid 46, 59 SmartCell Gateway 200 RESTful Interface Reference Guide for Release 2.5.1, 800-70700-001 Rev A 68 Copyright © 2006-2014. Ruckus Wireless, Inc. 350 West Java Dr. Sunnyvale, CA 94089. USA www.ruckuswireless.com
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.6 Linearized : Yes Author : Ruckus Wireless, Inc. Create Date : 2014:09:18 17:59:51Z Modify Date : 2014:09:18 18:14:28+05:30 Subject : SmartCell Gateway™ 200 RESTful Interface Reference Guide for Release 2.5.1 Language : en XMP Toolkit : Adobe XMP Core 5.4-c005 78.147326, 2012/08/23-13:03:03 Format : application/pdf Title : SmartCell Gateway™ 200 RESTful Interface Reference Guide for Release 2.5.1 Creator : Ruckus Wireless, Inc. Description : SmartCell Gateway™ 200 RESTful Interface Reference Guide for Release 2.5.1 Creator Tool : FrameMaker 11.0.2 Metadata Date : 2014:09:18 18:14:28+05:30 Producer : Acrobat Distiller 11.0 (Windows) Document ID : uuid:aa6fb78b-7511-4c6b-95db-9b5e86d6bf24 Instance ID : uuid:91c1544d-51e0-438d-a289-50fe2a6f16cd Page Mode : UseOutlines Page Count : 69EXIF Metadata provided by EXIF.tools