Manage a Metric
Get metric details and deletes the metric and it's dependent metric data from the system
Get the metric details.
Path Parameters
- tenantId
Describes clientId or mspId of the tenant
- metricName
Describes unique metric name
Responses
This endpoint accepts anyOf the following:
object
- metricName
- metricSource
- displayName
- description
- unit
- unitLabel
- groupName
- factor
- consolFunc
- displayByComponent
- displayOrder
- topMetric
- timeSeries
- warnRepeatCount
- criticalRepeatCount
- recommended
- useExpression
- unitConversionFactor
- status
- Enum:
- activedelete-pending
- type
- resourceType
object
- message
Loading Examples...
Post request to delete the metric from the system.
Notes
- The endpoint operates on a given metric-name at Tenant Level ( partner/client) is an asynchronous request to trigger the metric data cleanup process and metrics marked as "delete-pending" and gives 202 response code.
- The Delete endpoint removes the references from the system and deletes the generated metrics data.
- Once requested to delete, the metrics will not be operational and visible to users.
- Alerts with delete metric name will come to obsolete state.
- Unless the metric references are cleaned up users cannot create metrics with the same name which were just deleted.
- No graph data will get generated and old metric graph data will not be visible once deletion is completed.
- Metric data related to widgets etc which are created by users, it's the user responsibility to delete them.
Path Parameters
- tenantId
Describes clientId or mspId of the tenant
- metricName
Describes unique metric name
Responses
Loading Examples...