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

  • tenantIdstringrequired

    Describes clientId or mspId of the tenant

  • metricNamestringrequired

    Describes unique metric name

Responses

This endpoint accepts anyOf the following:

object

  • metricNamestring

  • metricSourcestring

  • displayNamestring

  • descriptionstring

  • unitstring

  • unitLabelstring

  • groupNamestring

  • factorinteger

  • consolFuncstring

  • displayByComponentboolean

  • displayOrderinteger

  • topMetricboolean

  • timeSeriesboolean

  • warnRepeatCountinteger

  • criticalRepeatCountinteger

  • recommendedinteger

  • useExpressionboolean

  • unitConversionFactorinteger

  • statusstring

    Enum:
    activedelete-pending
  • typestring

  • resourceTypestring

object

  • messagestring

Loading Examples...

Post request to delete the metric from the system.

Notes

  1. 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.
  2. The Delete endpoint removes the references from the system and deletes the generated metrics data.
  3. Once requested to delete, the metrics will not be operational and visible to users.
  4. Alerts with delete metric name will come to obsolete state.
  5. Unless the metric references are cleaned up users cannot create metrics with the same name which were just deleted.
  6. No graph data will get generated and old metric graph data will not be visible once deletion is completed.
  7. Metric data related to widgets etc which are created by users, it's the user responsibility to delete them.

Path Parameters

  • tenantIdstringrequired

    Describes clientId or mspId of the tenant

  • metricNamestringrequired

    Describes unique metric name

Responses

Loading Examples...