Get all CRC Utilization - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Get all CRC Utilization","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/fcd87bf2-3c6e-34f6-a91e-aaebbd04122b","info":{"title":"RESTCONF Performance APIs","description":"RESTCONF APIs exposed by Performance service.","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":"1.0.0"},"tags":[{"name":"RESTCONF APIs","description":"Points to note: \nThe actual response will,\n- Have namespace prefixed in the attribute name\n- Not have attributes whose values are null\n- Have the attribute names \"-\" separated in some cases\n- Have additional section with firstIndex and lastIndex attributes"}],"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/performance-restconf-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/performance/restconf/data/v1","description":"Generated server url"}]},"spec":{"tags":["RESTCONF APIs"],"summary":"Get all CRC Utilization","description":"\u003cb\u003eBatch Retrieval\u003c/b\u003e \nThe default max batch size for retrieval is set to 100 and maximum 100 objects can be retrieved. \n\u003cb\u003e.startIndex=<value>\u003c/b\u003e 0 based index as a start index of the data to be retrieved \n\u003cb\u003e.maxCount=<value>\u003c/b\u003e Maximum number of objects to be retrieved \n\n\u003cb\u003e\u003cfont color='red'\u003eMandatory query param\u003c/font\u003e\u003c/b\u003e \n\u003cb\u003enode-ref=<value>\u003c/b\u003e e.g 'MD=\u003cCISCO_EMS\u003e!ND=\\\u003cnodename\u003e', \nFDN of the node/device. It can be obtained from the node API response '/crosswork/inventory/restconf/data/v2/resource-physical:node'. \nFor e.g. in the json format of the response, \"nd.fdn\": \"MD=CISCO_EMS!ND=RON_NCS5700_14.cisco-lab.com\" \n\n\u003cb\u003etimeInterval=<value>\u003c/b\u003e e.g 30, for specified time interval in second \n\n\u003cb\u003einterfaceName=<value>\u003c/b\u003e for e.g 'HundredGigE0/0/2/1', \nDiscovered name of the termination point. It can be obtained from the termination point API response '/crosswork/inventory/restconf/data/v2/resource-ems:termination-point'. \nFor e.g. in the json format of the response, \"tp.discovered-name\": \"HundredGigE0/0/2/1\"","operationId":"getCrc","responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","description":"response","xml":{"name":"response-message","namespace":"urn:cisco:params:xml:ns:yang:nrf-common:v1","prefix":"ns12"},"properties":{"header":{"type":"object","description":"header","properties":{"firstIndex":{"type":"integer","format":"int64","description":"firstIndex","xml":{"prefix":"ns12"}},"lastIndex":{"type":"integer","format":"int64","description":"lastIndex","xml":{"prefix":"ns12"}}},"xml":{"prefix":"ns12"},"$$ref":"#/components/schemas/Header"},"data":{"type":"object","description":"data","xml":{"name":"data","prefix":"ns12"},"properties":{"perf-metrics":{"type":"array","description":"subscription","items":{"type":"object","description":"Holder for device and interface performance metrics","xml":{"name":"perf-metrics","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"metricName":{"type":"string","description":"Metric name","xml":{"name":"metric-name","prefix":""}},"average":{"type":"number","description":"Average value of metric","xml":{"name":"average","prefix":""}},"minimum":{"type":"number","description":"Minimum value of metric","xml":{"name":"minimum","prefix":""}},"maximum":{"type":"number","description":"Maximum value of metric","xml":{"name":"maximum","prefix":""}},"unit":{"type":"string","description":"Metric Unit Type","xml":{"name":"unit","prefix":""}},"metrics":{"type":"array","description":"Available metrics","xml":{"name":"metrics","prefix":""},"items":{"type":"object","description":"Metric grouping consolidated as keys and data","xml":{"name":"metrics","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"metricIndex":{"type":"integer","description":"Metric index","xml":{"name":"metric-index","prefix":""},"format":"int64"},"keys":{"type":"object","description":"Keys","xml":{"name":"keys","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"nodeRef":{"type":"string","description":"Node reference related to the metrics","xml":{"name":"node-ref","prefix":""}},"tpRef":{"type":"string","description":"Termination-Point reference related to the metrics","xml":{"name":"tp-ref","prefix":""}},"cpuName":{"type":"string","description":"cpu name","xml":{"name":"cpu-name","prefix":""}},"memoryPoolName":{"type":"string","description":"Memory pool name","xml":{"name":"memory-pool-name","prefix":""}},"sensorName":{"type":"string","description":"Sensor name","xml":{"name":"sensor-name","prefix":""}},"interfaceName":{"type":"string","description":"Interface name","xml":{"name":"interface-name","prefix":""}},"laneIndex":{"type":"integer","description":"Lane index","xml":{"name":"lane-index","prefix":""},"format":"int64"},"laneId":{"type":"integer","description":"Lane id","xml":{"name":"lane-id","prefix":""},"format":"int64"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Keys"},"data":{"type":"array","description":"data","items":{"type":"object","description":"Data","xml":{"name":"data","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"value":{"type":"integer","description":"Data value of the metric","xml":{"name":"value","prefix":""},"format":"int64"},"eventTime":{"type":"integer","description":"Data event time","xml":{"name":"event-time","prefix":""}},"timeStamp":{"type":"string","description":"Time stamp of the event","xml":{"name":"time-stamp","prefix":""}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Data"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Metrics"}},"entries":{"type":"array","description":"Available entries for ENV Temperature","xml":{"name":"entries","prefix":""},"items":{"type":"object","description":"Metric grouping consolidated as keys and data","xml":{"name":"","prefix":""},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"entryIndex":{"type":"integer","description":"entryIndex","xml":{"name":"entry-index","prefix":""},"format":"int64"},"keys":{"type":"object","description":"Keys","xml":{"name":"keys","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"nodeRef":{"type":"string","description":"Node reference related to the metrics","xml":{"name":"node-ref","prefix":""}},"tpRef":{"type":"string","description":"Termination-Point reference related to the metrics","xml":{"name":"tp-ref","prefix":""}},"cpuName":{"type":"string","description":"cpu name","xml":{"name":"cpu-name","prefix":""}},"memoryPoolName":{"type":"string","description":"Memory pool name","xml":{"name":"memory-pool-name","prefix":""}},"sensorName":{"type":"string","description":"Sensor name","xml":{"name":"sensor-name","prefix":""}},"interfaceName":{"type":"string","description":"Interface name","xml":{"name":"interface-name","prefix":""}},"laneIndex":{"type":"integer","description":"Lane index","xml":{"name":"lane-index","prefix":""},"format":"int64"},"laneId":{"type":"integer","description":"Lane id","xml":{"name":"lane-id","prefix":""},"format":"int64"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Keys"},"average":{"type":"number","description":"Average sensor temperature value","xml":{"name":"average","prefix":""}},"maximum":{"type":"number","description":"Maximum sensor temperature value","xml":{"name":"maximum","prefix":""}},"minimum":{"type":"number","description":"Mininum sensor temperature value","xml":{"name":"minimum","prefix":""}},"current":{"type":"number","description":"current sensor temperature value","xml":{"name":"current","prefix":""}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Entries"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/PerfMetrics"}}},"$$ref":"#/components/schemas/ResponseData"}},"$$ref":"#/components/schemas/ResponseMessage"},"examples":{"example":{"summary":"Sample response","value":{"com.response-message":{"com.header":{"com.firstIndex":0,"com.lastIndex":0},"com.data":{"perf.perf-metrics":[{"perf.metric-name":"crc","perf.average":0,"perf.minimum":0,"perf.maximum":0,"perf.unit":"PACKETS_PER_SECOND","perf.metrics":[{"perf.metric-index":0,"perf.keys":{"perf.node-ref":"MD=CISCO_EMS!ND=EPNM-NCS5508-43","perf.interface-name":"TenGigE0/1/2/1/0"},"perf.data":[{"perf.value":0,"perf.time-stamp":"2024-10-22T10:00:00Z"}]}]}]}}},"$$ref":"#/components/examples/GetCrcJson"}}},"application/xml":{"schema":{"type":"object","description":"response","xml":{"name":"response-message","namespace":"urn:cisco:params:xml:ns:yang:nrf-common:v1","prefix":"ns12"},"properties":{"header":{"type":"object","description":"header","properties":{"firstIndex":{"type":"integer","format":"int64","description":"firstIndex","xml":{"prefix":"ns12"}},"lastIndex":{"type":"integer","format":"int64","description":"lastIndex","xml":{"prefix":"ns12"}}},"xml":{"prefix":"ns12"},"$$ref":"#/components/schemas/Header"},"data":{"type":"object","description":"data","xml":{"name":"data","prefix":"ns12"},"properties":{"perf-metrics":{"type":"array","description":"subscription","items":{"type":"object","description":"Holder for device and interface performance metrics","xml":{"name":"perf-metrics","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"metricName":{"type":"string","description":"Metric name","xml":{"name":"metric-name","prefix":""}},"average":{"type":"number","description":"Average value of metric","xml":{"name":"average","prefix":""}},"minimum":{"type":"number","description":"Minimum value of metric","xml":{"name":"minimum","prefix":""}},"maximum":{"type":"number","description":"Maximum value of metric","xml":{"name":"maximum","prefix":""}},"unit":{"type":"string","description":"Metric Unit Type","xml":{"name":"unit","prefix":""}},"metrics":{"type":"array","description":"Available metrics","xml":{"name":"metrics","prefix":""},"items":{"type":"object","description":"Metric grouping consolidated as keys and data","xml":{"name":"metrics","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"metricIndex":{"type":"integer","description":"Metric index","xml":{"name":"metric-index","prefix":""},"format":"int64"},"keys":{"type":"object","description":"Keys","xml":{"name":"keys","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"nodeRef":{"type":"string","description":"Node reference related to the metrics","xml":{"name":"node-ref","prefix":""}},"tpRef":{"type":"string","description":"Termination-Point reference related to the metrics","xml":{"name":"tp-ref","prefix":""}},"cpuName":{"type":"string","description":"cpu name","xml":{"name":"cpu-name","prefix":""}},"memoryPoolName":{"type":"string","description":"Memory pool name","xml":{"name":"memory-pool-name","prefix":""}},"sensorName":{"type":"string","description":"Sensor name","xml":{"name":"sensor-name","prefix":""}},"interfaceName":{"type":"string","description":"Interface name","xml":{"name":"interface-name","prefix":""}},"laneIndex":{"type":"integer","description":"Lane index","xml":{"name":"lane-index","prefix":""},"format":"int64"},"laneId":{"type":"integer","description":"Lane id","xml":{"name":"lane-id","prefix":""},"format":"int64"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Keys"},"data":{"type":"array","description":"data","items":{"type":"object","description":"Data","xml":{"name":"data","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"value":{"type":"integer","description":"Data value of the metric","xml":{"name":"value","prefix":""},"format":"int64"},"eventTime":{"type":"integer","description":"Data event time","xml":{"name":"event-time","prefix":""}},"timeStamp":{"type":"string","description":"Time stamp of the event","xml":{"name":"time-stamp","prefix":""}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Data"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Metrics"}},"entries":{"type":"array","description":"Available entries for ENV Temperature","xml":{"name":"entries","prefix":""},"items":{"type":"object","description":"Metric grouping consolidated as keys and data","xml":{"name":"","prefix":""},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"entryIndex":{"type":"integer","description":"entryIndex","xml":{"name":"entry-index","prefix":""},"format":"int64"},"keys":{"type":"object","description":"Keys","xml":{"name":"keys","prefix":"ns2"},"properties":{"entityTag":{"type":"string","description":"Generic tag"},"nodeRef":{"type":"string","description":"Node reference related to the metrics","xml":{"name":"node-ref","prefix":""}},"tpRef":{"type":"string","description":"Termination-Point reference related to the metrics","xml":{"name":"tp-ref","prefix":""}},"cpuName":{"type":"string","description":"cpu name","xml":{"name":"cpu-name","prefix":""}},"memoryPoolName":{"type":"string","description":"Memory pool name","xml":{"name":"memory-pool-name","prefix":""}},"sensorName":{"type":"string","description":"Sensor name","xml":{"name":"sensor-name","prefix":""}},"interfaceName":{"type":"string","description":"Interface name","xml":{"name":"interface-name","prefix":""}},"laneIndex":{"type":"integer","description":"Lane index","xml":{"name":"lane-index","prefix":""},"format":"int64"},"laneId":{"type":"integer","description":"Lane id","xml":{"name":"lane-id","prefix":""},"format":"int64"},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Keys"},"average":{"type":"number","description":"Average sensor temperature value","xml":{"name":"average","prefix":""}},"maximum":{"type":"number","description":"Maximum sensor temperature value","xml":{"name":"maximum","prefix":""}},"minimum":{"type":"number","description":"Mininum sensor temperature value","xml":{"name":"minimum","prefix":""}},"current":{"type":"number","description":"current sensor temperature value","xml":{"name":"current","prefix":""}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/Entries"}},"any":{"type":"array","description":"Generic array","items":{"type":"object"}}},"$$ref":"#/components/schemas/PerfMetrics"}}},"$$ref":"#/components/schemas/ResponseData"}},"$$ref":"#/components/schemas/ResponseMessage"},"examples":{"example":{"summary":"Sample response","value":{"header":{"firstIndex":0,"lastIndex":0},"data":{"perf-metrics":[{"ns2:metric-name":"crc","ns2:average":0,"ns2:minimum":0,"ns2:maximum":0,"ns2:unit":"PACKETS_PER_SECOND","metrics":[{"ns2:metric-index":0,"keys":{"ns2:node-ref":"MD=CISCO_EMS!ND=EPNM-NCS5508-43","ns2:interface-name":"TenGigE0/1/2/1/0"},"data":[{"ns2:value":0,"ns2:time-stamp":"2024-10-22T10:00:00Z"}]}]}]}},"$$ref":"#/components/examples/GetCrcXml"}}}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"method":"get","path":"/resource-network:performance-crc"}}