Get Aggregate Metrics - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Aggregate Metrics","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get metrics related to the health of the device and interface attributes.**","operationId":"getAggregateMetrics","parameters":[{"description":"Metrics are governed by health policies deployed on the FTD. If the health module is disabled, there is a chance that metric data wont be available or is incomplete.\u003cbr/\u003eFilter criteria can be specified using the format \u003ccode\u003edevice_uuid:deviceUuid; metric:metric_name; timeRange:range.\u003c/code\u003e\u003cbr/\u003e\u003cbr/\u003e\u003ccode\u003edevice_uuid\u003c/code\u003e -- Identifier for device. There can only be one device offered per request. This is a mandatory parameter in the filter query.\u003cbr/\u003e\u003ccode\u003emetric\u003c/code\u003e -- Indicates the metric to be queried. Possible values are CPU, MEM, INTERFACE, DISK_STATS, CHASSIS_STATS and HA_INFO. If this filter is not used, all available metrics are retrieved.\u003cbr\u003e\u003ccode\u003etimeRange\u003c/code\u003e -- Enum which aids in retrieving the average metrics for time intervals. Possible values are 5m, 15m, 30m, and 1h. If this filter is not used, the average of the last five minutes will be shown by default.","in":"query","name":"filter","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /api/fmc_config/v1/domain/{domainUUID}/health/aggregateMetrics ( Retrieves aggregate health metrics of the devices )":{"value":{"items":[{"chassisStatsHealthMetrics":{"fanRpmAvgList":[{"name":"fanmod1_fan1","rpm":15720},{"name":"fanmod1_fan2","rpm":15720},{"name":"fanmod1_fan3","rpm":15600},{"name":"fanmod1_fan4","rpm":15600}]},"cpuHealthMetrics":{"linaUsageAvg":0,"snortUsageAvg":0,"systemUsageAvg":1.4125},"diskHealthMetrics":{"totalDiskUsageAvg":3},"endTime":"2024-10-20 16:48:30.948 UTC","id":"d20b1854-8a08-11ef-a60d-bce7e26aa0d9","interfaceHealthMetricsList":[{"bufferOverrunsAvg":0,"bufferUnderrunsAvg":0,"currentLinkStatus":"UP","dropPacketsAvg":0,"inputBytesAvg":532,"inputErrorsAvg":0,"inputPacketSizeAvg":0,"interface":"Management1/1","l2DecodeDropsAvg":0,"outputBytesAvg":1356,"outputErrorsAvg":0,"outputPacketSizeAvg":0},{"bufferOverrunsAvg":0,"bufferUnderrunsAvg":0,"currentLinkStatus":"DOWN","dropPacketsAvg":0,"inputBytesAvg":0,"inputErrorsAvg":0,"inputPacketSizeAvg":0,"interface":"Ethernet1/1","l2DecodeDropsAvg":0,"outputBytesAvg":0,"outputErrorsAvg":0,"outputPacketSizeAvg":0}],"memoryHealthMetrics":{"linaUsageAvg":32.27,"snortUsageAvg":3.35,"systemUsageAvg":22.3},"name":"TPK-07-01","startTime":"2024-10-20 16:43:30.948 UTC","type":"AggregateMetric"}],"paging":{"count":1,"limit":25,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Represents various device health metrics in an aggregated format.","properties":{"chassisStatsHealthMetrics":{"type":"object","description":"Represents chassis status health metrics such as fan speed in RPM values.","properties":{"fanRpmAvgList":{"items":{"type":"object","properties":{"name":{"type":"string"},"rpm":{"type":"number"}},"$$ref":"#/components/schemas/FanRpmAvg"},"type":"array"}},"$$ref":"#/components/schemas/ChassisStatsHealthMetrics"},"cpuHealthMetrics":{"type":"object","description":"Represents device CPU metrics in percentage values.","properties":{"linaUsageAvg":{"type":"number"},"snortUsageAvg":{"type":"number"},"systemUsageAvg":{"type":"number"}},"$$ref":"#/components/schemas/CPUHealthMetrics"},"description":{"type":"string"},"diskHealthMetrics":{"type":"object","description":"Represents device disk metrics in percentage values.","properties":{"totalDiskUsageAvg":{"type":"number"}},"$$ref":"#/components/schemas/DiskHealthMetrics"},"endTime":{"description":"End time of the metrics.","type":"string"},"haInfo":{"type":"object","description":"Represents the role and status of a high availability device.","properties":{"role":{"description":"Role of the device. Possible values are PRIMARY or SECONDARY.","type":"string"},"status":{"description":"Current status of the device. Possible values are Active, Standby, Failed, Disabled, Synchronizing, or Unknown.","type":"string"}},"$$ref":"#/components/schemas/HAInfo"},"id":{"description":"Unique identifier of the device.","type":"string"},"interfaceHealthMetricsList":{"items":{"type":"object","description":"Represents various interface metrics. Average counter values are displayed for metrics such as buffer runs and packet drops.","properties":{"bufferOverrunsAvg":{"type":"number"},"bufferUnderrunsAvg":{"type":"number"},"currentLinkStatus":{"enum":["UP","DOWN"],"type":"string"},"currentOperationalStatus":{"enum":["UP","DOWN"],"type":"string"},"dropPacketsAvg":{"type":"number"},"duplexMode":{"type":"string"},"inputBytesAvg":{"type":"number"},"inputErrorsAvg":{"type":"number"},"inputPacketSizeAvg":{"type":"number"},"interface":{"type":"string"},"interfaceName":{"type":"string"},"interfaceType":{"type":"string"},"l2DecodeDropsAvg":{"type":"number"},"outputBytesAvg":{"type":"number"},"outputErrorsAvg":{"type":"number"},"outputPacketSizeAvg":{"type":"number"}},"$$ref":"#/components/schemas/InterfaceHealthMetrics"},"type":"array"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"memoryHealthMetrics":{"type":"object","description":"Represents device memory metrics in percentage values.","properties":{"linaUsageAvg":{"type":"number"},"snortUsageAvg":{"type":"number"},"systemUsageAvg":{"type":"number"}},"$$ref":"#/components/schemas/MemoryHealthMetrics"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"description":"Name of the device.","type":"string"},"startTime":{"description":"Start time for the metrics.","type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/AggregateMetrics"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/AggregateMetricsListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Health"],"__originalOperationId":"getAggregateMetrics","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/health/aggregatemetrics"}}