Fetches all metrics that are collected for a specific PTP clock, as well as the URL of the next step ("PTP Clock Performance Data") that is available under the "url" element. Available metrics are: PTP Clock class, PTP Servo State,TX/RX packets,TX/RX packet rates and UTC offset
Example: op/statisticsService/ptp/metrics?device=10.56.23.109
Since Product Version: 2.0
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
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/op/statisticsService/ptp/metrics
Request Parameters
device
String
|
query
|
Required
Device IP or address
|
clockDomainIndex
Integer
|
query
|
Optional
|
clockTypeIndex
Integer
|
query
|
Optional
|
clockInstanceIndex
Integer
|
query
|
Optional
|
timeInterval
Integer
|
query
|
Optional
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.
|
startTime
Long
|
query
|
Optional
Specifies the start time in milli seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
Optional
Specifies the end time in milli seconds. The timeInterval parameter overrides this parameter.
|
owningEntityId
String
|
query
|
Optional
|
Response Parameters
info
String
|
|
metrics
MetricDetailsDTO[]
|
|
description
String
|
|
name
String
|
|
type
MetricTypeEnum
|
|
units
MetricUnitEnum[]
|
|
url
String
|
|
|
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://10.64.80.159/webacs/api/v1/op/statisticsService/ptp/metrics
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/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>STRING</units>
</units>
<url>String value</url>
</metrics>
<metrics>
<description>Another string value</description>
<name>Another string value</name>
<type>STATS</type>
<units>
<units>NUMBER</units>
<units>STRING</units>
</units>
<url>Another string value</url>
</metrics>
</metrics>
</metricsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v1/op/statisticsService/ptp/metrics.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/op\/statisticsService\/ptp\/metrics",
"@rootUrl" : "https : \/\/10.64.80.159\/webacs\/api\/v1\/op",
"metricsDTO" : {
"info" : "String value",
"metrics" : {
"metrics" : [{
"description" : "String value",
"name" : "String value",
"type" : "TIME_SERIES",
"units" : {
"units" : ["NUMBER",
"STRING"]
},
"url" : "String value"
},
{
"description" : "Another string value",
"name" : "Another string value",
"type" : "STATS",
"units" : {
"units" : ["NUMBER",
"STRING"]
},
"url" : "Another string value"
}]
}
}
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/op/statisticsService/ptp/metrics
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
Required
Device IP or address
|
clockDomainIndex
Integer
|
query
|
Optional
|
clockTypeIndex
Integer
|
query
|
Optional
|
clockInstanceIndex
Integer
|
query
|
Optional
|
timeInterval
Integer
|
query
|
Optional
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.
|
startTime
Long
|
query
|
Optional
Specifies the start time in milli seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
Optional
Specifies the end time in milli seconds. The timeInterval parameter overrides this parameter.
|
owningEntityId
String
|
query
|
Optional
|
Response Parameters
info
String
|
|
metrics
MetricDetailsDTO[]
|
|
description
String
|
|
name
String
|
|
type
MetricTypeEnum
|
|
units
MetricUnitEnum[]
|
|
url
String
|
|
|
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://10.64.80.159/webacs/api/v2/op/statisticsService/ptp/metrics
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v2/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>STRING</units>
</units>
<url>String value</url>
</metrics>
<metrics>
<description>Another string value</description>
<name>Another string value</name>
<type>STATS</type>
<units>
<units>NUMBER</units>
<units>STRING</units>
</units>
<url>Another string value</url>
</metrics>
</metrics>
</metricsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v2/op/statisticsService/ptp/metrics.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v2/op",
"metricsDTO" : [ {
"info" : "String value",
"metrics" : {
"metrics" : [ {
"description" : "String value",
"name" : "String value",
"type" : "TIME_SERIES",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "String value"
}, {
"description" : "Another string value",
"name" : "Another string value",
"type" : "STATS",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "Another string value"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/op/statisticsService/ptp/metrics
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
Required
Device IP or address
|
clockDomainIndex
Integer
|
query
|
Optional
|
clockTypeIndex
Integer
|
query
|
Optional
|
clockInstanceIndex
Integer
|
query
|
Optional
|
timeInterval
Integer
|
query
|
Optional
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.
|
startTime
Long
|
query
|
Optional
Specifies the start time in milli seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
Optional
Specifies the end time in milli seconds. The timeInterval parameter overrides this parameter.
|
owningEntityId
String
|
query
|
Optional
|
Response Parameters
info
String
|
|
metrics
MetricDetailsDTO[]
|
|
description
String
|
|
name
String
|
|
type
MetricTypeEnum
|
|
units
MetricUnitEnum[]
|
|
url
String
|
|
|
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://10.64.80.159/webacs/api/v3/op/statisticsService/ptp/metrics
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v3/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>STRING</units>
</units>
<url>String value</url>
</metrics>
<metrics>
<description>Another string value</description>
<name>Another string value</name>
<type>STATS</type>
<units>
<units>NUMBER</units>
<units>STRING</units>
</units>
<url>Another string value</url>
</metrics>
</metrics>
</metricsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v3/op/statisticsService/ptp/metrics.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v3/op",
"metricsDTO" : [ {
"info" : "String value",
"metrics" : {
"metrics" : [ {
"description" : "String value",
"name" : "String value",
"type" : "TIME_SERIES",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "String value"
}, {
"description" : "Another string value",
"name" : "Another string value",
"type" : "STATS",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "Another string value"
} ]
}
} ]
}
}
Resource Information
Rate Limiting?
|
No
|
Sorting?
|
No
|
Paging?
|
No
|
Filtering?
|
No
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/op/statisticsService/ptp/metrics
Unmodified
This resource has not been modified since the previous API version.
Request Parameters
device
String
|
query
|
Required
Device IP or address
|
clockDomainIndex
Integer
|
query
|
Optional
|
clockTypeIndex
Integer
|
query
|
Optional
|
clockInstanceIndex
Integer
|
query
|
Optional
|
timeInterval
Integer
|
query
|
Optional
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.
|
startTime
Long
|
query
|
Optional
Specifies the start time in milli seconds. The timeInterval parameter overrides this parameter.
|
endTime
Long
|
query
|
Optional
Specifies the end time in milli seconds. The timeInterval parameter overrides this parameter.
|
owningEntityId
String
|
query
|
Optional
|
Response Parameters
info
String
|
|
metrics
MetricDetailsDTO[]
|
|
description
String
|
|
name
String
|
|
type
MetricTypeEnum
|
|
units
MetricUnitEnum[]
|
|
url
String
|
|
|
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://10.64.80.159/webacs/api/v4/op/statisticsService/ptp/metrics
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.80.159/webacs/api/v4/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>STRING</units>
</units>
<url>String value</url>
</metrics>
<metrics>
<description>Another string value</description>
<name>Another string value</name>
<type>STATS</type>
<units>
<units>NUMBER</units>
<units>STRING</units>
</units>
<url>Another string value</url>
</metrics>
</metrics>
</metricsDTO>
</mgmtResponse>
Sample JSON Response Payload
https://10.64.80.159/webacs/api/v4/op/statisticsService/ptp/metrics.json
{
"mgmtResponse" : {
"@requestUrl" : "../../../../../../pages/common/login.jsp.html",
"@responseType" : "operation",
"@rootUrl" : "https://10.64.80.159/webacs/api/v4/op",
"metricsDTO" : [ {
"info" : "String value",
"metrics" : {
"metrics" : [ {
"description" : "String value",
"name" : "String value",
"type" : "TIME_SERIES",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "String value"
}, {
"description" : "Another string value",
"name" : "Another string value",
"type" : "STATS",
"units" : {
"units" : [ "NUMBER", "STRING" ]
},
"url" : "Another string value"
} ]
}
} ]
}
}