Example: op/statisticsService/tdm/PATH/metrics/UASFE?startTime=1498993027544& endTime=1498996627544&metricDataType=TIME_SERIES&device=10.56.23.63& ifName=E1 0/3/0
Since Product Version: 2.0
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- BNG IP Pool Statistics (3)
- BNG Sessions Statistics (3)
- CEM Statistics (3)
- CLI Template Configuration (12)
- Circuit Statistics (4)
- Clients (7)
- Compliance Service (5)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (6)
- Device Operations (9)
- Device Sensors Statistics (3)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (6)
- IPSLA (ICMP JITTER) Statistics (3)
- IPSLA Y1731 Statistics (3)
- Interface CRC Errors Statistics (3)
- Job Operations (6)
- Link Statistics (3)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Me1200 Quality of Service Statistics (3)
- Network Topology Layout (2)
- Optical Ethernet Statistics (3)
- Optical OTN Data Statistics (3)
- Optical Physical Statistics (3)
- Optical SFP Statistics (3)
- Optical Sonet SDH Statistics (3)
- PTP Clock Statistics (3)
- PTP and SyncE settings (5)
- Plug and Play (11)
- Quality of Service Statistics (3)
- Rate Limits Management Service (2)
- Report Service (4)
- Software Updates (2)
- Statistics (91)
- SyncE Statistics (3)
- System Settings (26)
- TDM and Sonet Port Statistics (3)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- Y1731 Bins Statistics (3)
- v1
- v2
- v3
- v4
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
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/op/statisticsService/tdm/{section}/metrics/{metric}Request Parameters
Attribute | Source | Description |
---|---|---|
metric String |
path |
RequiredDefines the name of the metric for which the data needs to be fetched. |
device String |
query |
RequiredDefines the IP address of the device to which the TDM and SONET port belongs. |
ifName String |
query |
RequiredDefines the name of the interface on which the TDM and SONET statistics will be fetched |
section String |
path |
RequiredSpecifies the section on which statistics are collected. Valid values are: LINE, PATH, CISCO-PATH, CISCO-SECTION, CISCO-LINE, VT-PATH. |
timeInterval Integer |
query |
OptionalFetches the data for the last specified number of hours. Applicable values are 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided. |
startTime Long |
query |
OptionalSpecifies the start time in milliseconds. The timeInterval parameter overrides this parameter. |
endTime Long |
query |
OptionalSpecifies the end time in milliseconds. The timeInterval parameter overrides this parameter. |
firstResult Integer |
query |
OptionalDefines the offset from the first result you want to fetch. Default is 0. |
maxResults Integer |
query |
OptionalDefines the maximum number of hits to be returned. Default is 20. |
sort String |
query |
OptionalDefines a comma-separated list of attribute names with their respective order. |
metricDataType String |
query |
OptionalDetermines the query type to retrieve the KPi. Valid values are TOP_N or TIME_SERIES |
Response Parameters
Attribute | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
currentDateTime String |
Current timestamp |
|||||||||||
description String |
Metric description |
|||||||||||
metricName String |
Metric name |
|||||||||||
Metric data list |
||||||||||||
|
||||||||||||
resourceName String |
Resource name |
|||||||||||
Properties of X values |
||||||||||||
|
||||||||||||
Properties of Y values |
||||||||||||
|
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 Response Payload
https://172.25.123.114/webacs/api/v1/op/statisticsService/tdm/{section}/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v1/op/statisticsService/tdm/{section}/metrics/{metric}" rootUrl="https://172.25.123.114/webacs/api/v1/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<YLabels>
<YLabels>String value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
</YValues>
</metricRows>
</metricRows>
<resourceName>String value</resourceName>
<XValueProperty>
<label>String value</label>
<unit>NUMBER</unit>
</XValueProperty>
<YValueProperty>
<YValueProperty>
<label>String value</label>
<maxVal>4.0</maxVal>
<minVal>4.0</minVal>
<unit>NUMBER</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/statisticsService/tdm/{section}/metrics/{metric}.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/tdm\/{
section
}\/metrics\/{
metric
}",
"@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op",
"metricData" : {
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : {
"issue" : "String value",
"XValue" : "String value",
"YLabels" : {
"YLabels" : "String value"
},
"YValues" : {
"YValues" : 15
}
}
},
"resourceName" : "String value",
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"YValueProperty" : {
"label" : "String value",
"maxVal" : 4,
"minVal" : 4,
"unit" : "NUMBER"
}
}
}
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v2/op/statisticsService/tdm/{section}/metrics/{metric}Unmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
metric String |
path |
RequiredDefines the name of the metric for which the data needs to be fetched. |
device String |
query |
RequiredDefines the IP address of the device to which the TDM and SONET port belongs. |
ifName String |
query |
RequiredDefines the name of the interface on which the TDM and SONET statistics will be fetched |
section String |
path |
RequiredSpecifies the section on which statistics are collected. Valid values are: LINE, PATH, CISCO-PATH, CISCO-SECTION, CISCO-LINE, VT-PATH. |
timeInterval Integer |
query |
OptionalFetches the data for the last specified number of hours. Applicable values are 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided. |
startTime Long |
query |
OptionalSpecifies the start time in milliseconds. The timeInterval parameter overrides this parameter. |
endTime Long |
query |
OptionalSpecifies the end time in milliseconds. The timeInterval parameter overrides this parameter. |
firstResult Integer |
query |
OptionalDefines the offset from the first result you want to fetch. Default is 0. |
maxResults Integer |
query |
OptionalDefines the maximum number of hits to be returned. Default is 20. |
sort String |
query |
OptionalDefines a comma-separated list of attribute names with their respective order. |
metricDataType String |
query |
OptionalDetermines the query type to retrieve the KPi. Valid values are TOP_N or TIME_SERIES |
Response Parameters
Attribute | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
currentDateTime String |
Current timestamp |
|||||||||||
description String |
Metric description |
|||||||||||
metricName String |
Metric name |
|||||||||||
Metric data list |
||||||||||||
|
||||||||||||
resourceName String |
Resource name |
|||||||||||
Properties of X values |
||||||||||||
|
||||||||||||
Properties of Y values |
||||||||||||
|
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 Response Payload
https://172.25.123.114/webacs/api/v2/op/statisticsService/tdm/{section}/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v2/op/statisticsService/tdm/{section}/metrics/{metric}" rootUrl="https://172.25.123.114/webacs/api/v2/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<YLabels>
<YLabels>String value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
</YValues>
</metricRows>
</metricRows>
<resourceName>String value</resourceName>
<XValueProperty>
<label>String value</label>
<unit>NUMBER</unit>
</XValueProperty>
<YValueProperty>
<YValueProperty>
<label>String value</label>
<maxVal>4.0</maxVal>
<minVal>4.0</minVal>
<unit>NUMBER</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v2/op/statisticsService/tdm/{section}/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.25.123.114/webacs/api/v2/op/statisticsService/tdm/{section}/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://172.25.123.114/webacs/api/v2/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YLabels" : {
"ylabels" : [ "String value" ]
},
"YValues" : {
"yvalues" : [ 15.0 ]
},
"issue" : "String value"
} ]
},
"resourceName" : "String value"
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v3/op/statisticsService/tdm/{section}/metrics/{metric}Unmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
metric String |
path |
RequiredDefines the name of the metric for which the data needs to be fetched. |
device String |
query |
RequiredDefines the IP address of the device to which the TDM and SONET port belongs. |
ifName String |
query |
RequiredDefines the name of the interface on which the TDM and SONET statistics will be fetched |
section String |
path |
RequiredSpecifies the section on which statistics are collected. Valid values are: LINE, PATH, CISCO-PATH, CISCO-SECTION, CISCO-LINE, VT-PATH. |
timeInterval Integer |
query |
OptionalFetches the data for the last specified number of hours. Applicable values are 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided. |
startTime Long |
query |
OptionalSpecifies the start time in milliseconds. The timeInterval parameter overrides this parameter. |
endTime Long |
query |
OptionalSpecifies the end time in milliseconds. The timeInterval parameter overrides this parameter. |
firstResult Integer |
query |
OptionalDefines the offset from the first result you want to fetch. Default is 0. |
maxResults Integer |
query |
OptionalDefines the maximum number of hits to be returned. Default is 20. |
sort String |
query |
OptionalDefines a comma-separated list of attribute names with their respective order. |
metricDataType String |
query |
OptionalDetermines the query type to retrieve the KPi. Valid values are TOP_N or TIME_SERIES |
Response Parameters
Attribute | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
currentDateTime String |
Current timestamp |
|||||||||||
description String |
Metric description |
|||||||||||
metricName String |
Metric name |
|||||||||||
Metric data list |
||||||||||||
|
||||||||||||
resourceName String |
Resource name |
|||||||||||
Properties of X values |
||||||||||||
|
||||||||||||
Properties of Y values |
||||||||||||
|
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 Response Payload
https://172.25.123.114/webacs/api/v3/op/statisticsService/tdm/{section}/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v3/op/statisticsService/tdm/{section}/metrics/{metric}" rootUrl="https://172.25.123.114/webacs/api/v3/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
</metricRows>
<resourceName>String value</resourceName>
<XValueProperty>
<label>String value</label>
<unit>NUMBER</unit>
</XValueProperty>
<YValueProperty>
<YValueProperty>
<label>String value</label>
<maxVal>4.0</maxVal>
<minVal>4.0</minVal>
<unit>NUMBER</unit>
</YValueProperty>
<YValueProperty>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v3/op/statisticsService/tdm/{section}/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.25.123.114/webacs/api/v3/op/statisticsService/tdm/{section}/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://172.25.123.114/webacs/api/v3/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
}, {
"label" : "Another string value",
"maxVal" : 14.0,
"minVal" : 14.0,
"unit" : "STRING"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "String value"
}, {
"XValue" : "Another string value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "Another string value"
} ]
},
"resourceName" : "String value"
} ]
}
}
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
Resource URL
/webacs/api/v4/op/statisticsService/tdm/{section}/metrics/{metric}Unmodified
This resource has not been modified since the previous API version.
Request Parameters
Attribute | Source | Description |
---|---|---|
metric String |
path |
RequiredDefines the name of the metric for which the data needs to be fetched. |
device String |
query |
RequiredDefines the IP address of the device to which the TDM and SONET port belongs. |
ifName String |
query |
RequiredDefines the name of the interface on which the TDM and SONET statistics will be fetched |
section String |
path |
RequiredSpecifies the section on which statistics are collected. Valid values are: LINE, PATH, CISCO-PATH, CISCO-SECTION, CISCO-LINE, VT-PATH. |
timeInterval Integer |
query |
OptionalFetches the data for the last specified number of hours. Applicable values are 1, 2, 4, 8, 16, 24, 168 (1 Week), 336 (2 Weeks), 720 (1 Month), 8760 (1Year). The timeInterval parameter overrides the startTime and endTime parameters. The default is 1 hour if neither the timeInterval nor the startTime and endTime parameters are provided. |
startTime Long |
query |
OptionalSpecifies the start time in milliseconds. The timeInterval parameter overrides this parameter. |
endTime Long |
query |
OptionalSpecifies the end time in milliseconds. The timeInterval parameter overrides this parameter. |
firstResult Integer |
query |
OptionalDefines the offset from the first result you want to fetch. Default is 0. |
maxResults Integer |
query |
OptionalDefines the maximum number of hits to be returned. Default is 20. |
sort String |
query |
OptionalDefines a comma-separated list of attribute names with their respective order. |
metricDataType String |
query |
OptionalDetermines the query type to retrieve the KPi. Valid values are TOP_N or TIME_SERIES |
Response Parameters
Attribute | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
currentDateTime String |
Current timestamp |
|||||||||||
description String |
Metric description |
|||||||||||
metricName String |
Metric name |
|||||||||||
Metric data list |
||||||||||||
|
||||||||||||
resourceName String |
Resource name |
|||||||||||
Properties of X values |
||||||||||||
|
||||||||||||
Properties of Y values |
||||||||||||
|
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 Response Payload
https://172.25.123.114/webacs/api/v4/op/statisticsService/tdm/{section}/metrics/{metric}
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.25.123.114/webacs/api/v4/op/statisticsService/tdm/{section}/metrics/{metric}" rootUrl="https://172.25.123.114/webacs/api/v4/op">
<metricData>
<currentDateTime>String value</currentDateTime>
<description>String value</description>
<metricName>String value</metricName>
<metricRows>
<metricRows>
<issue>String value</issue>
<XValue>String value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
<metricRows>
<issue>Another string value</issue>
<XValue>Another string value</XValue>
<YLabels>
<YLabels>String value</YLabels>
<YLabels>Another string value</YLabels>
</YLabels>
<YValues>
<YValues>15.0</YValues>
<YValues>25.0</YValues>
</YValues>
</metricRows>
</metricRows>
<resourceName>String value</resourceName>
<XValueProperty>
<label>String value</label>
<unit>NUMBER</unit>
</XValueProperty>
<YValueProperty>
<YValueProperty>
<label>String value</label>
<maxVal>4.0</maxVal>
<minVal>4.0</minVal>
<unit>NUMBER</unit>
</YValueProperty>
<YValueProperty>
<label>Another string value</label>
<maxVal>14.0</maxVal>
<minVal>14.0</minVal>
<unit>STRING</unit>
</YValueProperty>
</YValueProperty>
</metricData>
</mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v4/op/statisticsService/tdm/{section}/metrics/{metric}.json
{
"mgmtResponse" : {
"@requestUrl" : "https://172.25.123.114/webacs/api/v4/op/statisticsService/tdm/{section}/metrics/{metric}",
"@responseType" : "operation",
"@rootUrl" : "https://172.25.123.114/webacs/api/v4/op",
"metricData" : [ {
"XValueProperty" : {
"label" : "String value",
"unit" : "NUMBER"
},
"YValueProperty" : {
"yvalueProperty" : [ {
"label" : "String value",
"maxVal" : 4.0,
"minVal" : 4.0,
"unit" : "NUMBER"
}, {
"label" : "Another string value",
"maxVal" : 14.0,
"minVal" : 14.0,
"unit" : "STRING"
} ]
},
"currentDateTime" : "String value",
"description" : "String value",
"metricName" : "String value",
"metricRows" : {
"metricRows" : [ {
"XValue" : "String value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "String value"
}, {
"XValue" : "Another string value",
"YLabels" : {
"ylabels" : [ "String value", "Another string value" ]
},
"YValues" : {
"yvalues" : [ 15.0, 25.0 ]
},
"issue" : "Another string value"
} ]
},
"resourceName" : "String value"
} ]
}
}