Private Resource
This resource is not part of the public API and may be changed or removed without notice. The use of this resource is not supported by Cisco. Use it at your own risk.
Represents the latest load statistics information for radio interfaces of lightweight wireless access points collected from WLAN controllers. Note that when access points are in a dissociated state, the radio interface statistics presented by the RFLoadStats resource is not collected from WLAN controllers. When queried, the API presents information from the latest successful data collection event.
Since Product Version: Unspecified
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/RFLoadStats
Response Parameters
channelUtilization
int
|
|
clientCount
int
|
Number of associated clients
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
macAddress
String
|
|
poorCoverageClients
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txUtilization
int
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.78.83.125/webacs/api/v1/data/RFLoadStats/15
<?xml version="1.0" ?>
<queryResponse type="RFLoadStats" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v1/data/RFLoadStats/15" rootUrl="https://10.78.83.125/webacs/api/v1/data">
<entity dtoType="rFLoadStatsDTO" type="RFLoadStats" url="https://10.78.83.125/webacs/api/v1/data/RFLoadStats/15">
<rfLoadStatsDTO displayName="String value" id="15" uuid="String value">
<channelUtilization>1</channelUtilization>
<clientCount>1</clientCount>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<txUtilization>1</txUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<slotId>String value</slotId>
</rfLoadStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v1/data/RFLoadStats/15.json
{
"queryResponse" : {
"@type" : "RFLoadStats",
"@responseType" : "getEntity",
"@requestUrl" : "https : //10.78.83.125/webacs/api/v1/data/RFLoadStats/15",
"@rootUrl" : "https : //10.78.83.125/webacs/api/v1/data",
"entity" : {
"@dtoType" : "rFLoadStatsDTO",
"@type" : "RFLoadStats",
"@url" : "https : //10.78.83.125/webacs/api/v1/data/RFLoadStats/15",
"rfLoadStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelUtilization" : 1,
"clientCount" : 1,
"poorCoverageClients" : 1,
"rxUtilization" : 1,
"txUtilization" : 1,
"collectionTime" : "String value",
"ethernetMac" : "String value",
"macAddress" : "String value",
"slotId" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/RFLoadStats
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
channelUtilization
int
|
|
clientCount
int
|
Number of associated clients
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
macAddress
String
|
|
poorCoverageClients
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txUtilization
int
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.78.83.125/webacs/api/v2/data/RFLoadStats/15
<?xml version="1.0" ?>
<queryResponse type="RFLoadStats" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v2/data/RFLoadStats/15" rootUrl="https://10.78.83.125/webacs/api/v2/data">
<entity dtoType="rFLoadStatsDTO" type="RFLoadStats" url="https://10.78.83.125/webacs/api/v2/data/RFLoadStats/15">
<rfLoadStatsDTO displayName="String value" id="15" uuid="String value">
<channelUtilization>1</channelUtilization>
<clientCount>1</clientCount>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<txUtilization>1</txUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<slotId>String value</slotId>
</rfLoadStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v2/data/RFLoadStats/15.json
{
"queryResponse" : {
"@type" : "RFLoadStats",
"@requestUrl" : "https://10.78.83.125/webacs/api/v2/data/RFLoadStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.78.83.125/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "rFLoadStatsDTO",
"@type" : "RFLoadStats",
"@url" : "https://10.78.83.125/webacs/api/v2/data/RFLoadStats/15",
"rfLoadStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "String value",
"ethernetMac" : "String value",
"macAddress" : "String value",
"poorCoverageClients" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txUtilization" : 1
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/RFLoadStats
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
channelUtilization
int
|
|
clientCount
int
|
Number of associated clients
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
macAddress
String
|
|
poorCoverageClients
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txUtilization
int
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.78.83.125/webacs/api/v3/data/RFLoadStats/15
<?xml version="1.0" ?>
<queryResponse type="RFLoadStats" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v3/data/RFLoadStats/15" rootUrl="https://10.78.83.125/webacs/api/v3/data">
<entity dtoType="rFLoadStatsDTO" type="RFLoadStats" url="https://10.78.83.125/webacs/api/v3/data/RFLoadStats/15">
<rfLoadStatsDTO displayName="String value" id="15" uuid="String value">
<channelUtilization>1</channelUtilization>
<clientCount>1</clientCount>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<txUtilization>1</txUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<slotId>String value</slotId>
</rfLoadStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v3/data/RFLoadStats/15.json
{
"queryResponse" : {
"@type" : "RFLoadStats",
"@requestUrl" : "https://10.78.83.125/webacs/api/v3/data/RFLoadStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.78.83.125/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "rFLoadStatsDTO",
"@type" : "RFLoadStats",
"@url" : "https://10.78.83.125/webacs/api/v3/data/RFLoadStats/15",
"rfLoadStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "String value",
"ethernetMac" : "String value",
"macAddress" : "String value",
"poorCoverageClients" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txUtilization" : 1
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/RFLoadStats
Unmodified
This resource has not been modified since the previous API version.
Response Parameters
channelUtilization
int
|
|
clientCount
int
|
Number of associated clients
|
collectionTime
String
|
The time collection of this record was finished, measured in milliseconds since the Unix epoch.
|
ethernetMac
String
|
MAC address of the ethernet interface on the AP
|
macAddress
String
|
|
poorCoverageClients
int
|
|
rxUtilization
int
|
|
slotId
String
|
|
txUtilization
int
|
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.78.83.125/webacs/api/v4/data/RFLoadStats/15
<?xml version="1.0" ?>
<queryResponse type="RFLoadStats" responseType="getEntity" requestUrl="https://10.78.83.125/webacs/api/v4/data/RFLoadStats/15" rootUrl="https://10.78.83.125/webacs/api/v4/data">
<entity dtoType="rFLoadStatsDTO" type="RFLoadStats" url="https://10.78.83.125/webacs/api/v4/data/RFLoadStats/15">
<rfLoadStatsDTO displayName="String value" id="15" uuid="String value">
<channelUtilization>1</channelUtilization>
<clientCount>1</clientCount>
<poorCoverageClients>1</poorCoverageClients>
<rxUtilization>1</rxUtilization>
<txUtilization>1</txUtilization>
<collectionTime>String value</collectionTime>
<ethernetMac>String value</ethernetMac>
<macAddress>String value</macAddress>
<slotId>String value</slotId>
</rfLoadStatsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.78.83.125/webacs/api/v4/data/RFLoadStats/15.json
{
"queryResponse" : {
"@type" : "RFLoadStats",
"@requestUrl" : "https://10.78.83.125/webacs/api/v4/data/RFLoadStats/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.78.83.125/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "rFLoadStatsDTO",
"@type" : "RFLoadStats",
"@url" : "https://10.78.83.125/webacs/api/v4/data/RFLoadStats/15",
"rfLoadStatsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"channelUtilization" : 1,
"clientCount" : 1,
"collectionTime" : "String value",
"ethernetMac" : "String value",
"macAddress" : "String value",
"poorCoverageClients" : 1,
"rxUtilization" : 1,
"slotId" : "String value",
"txUtilization" : 1
}
} ]
}
}