{"type":"api","title":"Retrieve SR policy performance metrics","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/1d80624b-479e-34fb-8b53-50017ed1766d","info":{"title":"Performance Metrics","description":"This module defines a Data Model for reporting various performance metrics in Crosswork.\nThese statistics tend to be attributes that are constantly changing.\nFor this reason, they are not included in their respective topology models, as that would\nimply constant updates via notifications for all the relevant entities (eg. Links and SR Policies).\nThis model is provided as a way to query for these performance metrics as needed.\nThere's no mechanism to subscribe to these changes via notifications.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"tags":[{"name":"Operational data","description":"Operational data resources"}],"openapi":"3.0.1","servers":[{"url":"https://{cnc-host}:{cnc-port}/crosswork/nbi/topology/v3/restconf","variables":{"cnc-host":{"default":"127.0.0.1","description":"host name or ip address of the target CNC Cluster"},"cnc-port":{"default":"30603","description":"port number of the target CNC Cluster"}}}],"securitySchemes":{"basicAuth":{"description":"authentication","type":"http","scheme":"basic"}}},"spec":{"tags":["Operational data","Since 3.0"],"summary":"Retrieve SR policy performance metrics","description":"Attributes related to performance metrics for a single SR policy.","operationId":"data_cisco_crosswork_performance_metrics_sr_policies_performance_metrics_sr_policy_pm_sr_policy_pm_headend_sr_policy_pm_endpoint_sr_policy_pm_color_get","parameters":[{"name":"policy-headend","in":"path","description":"Policy head end Router ID","required":true,"schema":{"type":"string","format":"union"}},{"name":"policy-endpoint","in":"path","description":"Policy endpoint IP address","required":true,"schema":{"type":"string","format":"union"}},{"name":"policy-color","in":"path","description":"Color associated with the policy","required":true,"schema":{"type":"integer","format":"uint32"}}],"responses":{"200":{"description":"Attributes related to performance metrics for a single SR policy.","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cisco-crosswork-performance-metrics:sr-policy-pm":{"type":"array","description":"Attributes related to performance metrics for a single SR policy.","items":{"type":"object","properties":{"headend":{"type":"string","description":"Policy head end IP address","format":"union"},"endpoint":{"type":"string","description":"Policy end point IP address","format":"union"},"color":{"type":"integer","description":"Color associated with the policy","format":"uint32"},"bandwidth-utilization-kbps":{"type":"integer","description":"Current bandwidth utilization for this SR policy, in kilobits per second.","format":"uint64"},"delay":{"type":"integer","description":"Current one directional delay for this SR policy, in microseconds.","format":"uint32"},"delay-telemetry":{"type":"integer","description":"Current delay for this SR policy, in microseconds. This value comes from NAPM telemetry.","format":"uint32"},"jitter-telemetry":{"type":"integer","description":"Current jitter for this SR policy, in microseconds. This value comes from NAPM telemetry.","format":"uint32"},"liveness-telemetry":{"type":"string","description":"Session state. This value comes from NAPM telemetry.","format":"boolean"}}}}}}}}},"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request","content":{}},"401":{"description":"Unauthorized","content":{}},"404":{"description":"Not Found","content":{}},"405":{"description":"Method Not Allowed","content":{}},"409":{"description":"Conflict","content":{}}},"security":[{"basicAuth":[]}],"__originalOperationId":"data_cisco_crosswork_performance_metrics_sr_policies_performance_metrics_sr_policy_pm_sr_policy_pm_headend_sr_policy_pm_endpoint_sr_policy_pm_color_get","method":"get","path":"/data/cisco-crosswork-performance-metrics:sr-policies-performance-metrics/sr-policy-pm={policy-headend},{policy-endpoint},{policy-color}"}}