Example: op/statisticsService/ipsla/metrics?device=10.56.23.49&targetIp=130.1.2.1& vrfName=L3VPN_RK_01&ipslaType=ICMP Echo&tos=0
Since Product Version: 2.0
Resource URL
/webacs/api/v1/op/statisticsService/ipsla/metricsRequest Parameters
Type | Attribute Name | Source | Description |
---|---|---|---|
String |
device optional |
query |
Device IP or name of the source probe |
String |
targetIp optional |
query |
Device IP of the target probe |
String |
vrfName optional |
query |
|
String |
ipslaType optional |
query |
Valid options are Echo, UDPEcho, TCPConnect, Jitter, ICMPJitter |
Integer |
tos optional |
query |
The type of service octet in an IP header. |
Integer |
timeInterval optional |
query |
Specifies the range of time (in hours). This field can contain values like 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. By default is 1 hour if neither timeInterval parameter nor the parameters startTime and endTime not provided. |
Long |
startTime optional |
query |
Specifies the start time in milli seconds. The timeInterval parameter overrides this parameter. |
Long |
endTime optional |
query |
Specifies the end time in milli seconds. The timeInterval parameter overrides this parameter. |
Response Parameters
Type | Attribute Name | Description |
---|---|---|
String |
info |
Metrics info |
metrics |
Metric details list |
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/ipsla/metrics
<?xml version="1.0" ?> <mgmtResponse responseType="operation" requestUrl="../../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/"> <metricsDTO> <info>String value</info> <metrics> <metrics> <description>String value</description> <name>String value</name> <type>TIME_SERIES</type> <units> <units>NUMBER</units> </units> <url>String value</url> </metrics> </metrics> </metricsDTO> </mgmtResponse>
Sample JSON Response Payload
https://172.25.123.114/webacs/api/v1/op/statisticsService/ipsla/metrics.json
{ "mgmtResponse" : { "@responseType" : "operation", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/statisticsService\/ipsla\/metrics", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/", "metricsDTO" : { "info" : "String value", "metrics" : { "metrics" : { "description" : "String value", "name" : "String value", "type" : "TIME_SERIES", "units" : { "units" : "NUMBER" }, "url" : "String value" } } } } }