Endpoint
/api/v2/metric/tenants/{tenantId}/metrictype
Path Parameters
tenantId
string

Describes clientId or mspId of the tenant

component
string

consolFunc
string

data
object

description
string

Summary of the metric type.

displayByComponent
boolean

displayName
string

Metric display name.

displayOrder
integer

displayUnit
string

(Optional) Unit name displayed in the graph.

factor
integer

groupName
string

(Optional) Metric group name.

lastVals
object

maxVals
object

metric
string

Metric type name.

metricType
string

Metric type.

minVals
object

resource
integer

resourceType
string

(Optional) Resource type.

timeSeriesType
string

topMetric
boolean

unit
string

Metric type unit.

unitLabel
string

(Optional) Label of the y-axis in the graph widget).

{
  "description": "Sample metric please ignore",
  "displayName": "TestMetric",
  "displayUnit": "Percentage (%)",
  "groupName": "system.test.*",
  "metricName": "system.metric.device.test",
  "resourceType": "CPU",
  "type": "Guage",
  "unit": "%",
  "unitLabel": "Percentage (%)"
}

Responses

MetricType already exists

MetricType created

component
string

consolFunc
string

data
object

description
string

Summary of the metric type.

displayByComponent
boolean

displayName
string

Metric display name.

displayOrder
integer

displayUnit
string

(Optional) Unit name displayed in the graph.

factor
integer

groupName
string

(Optional) Metric group name.

lastVals
object

maxVals
object

metric
string

Metric type name.

metricType
string

Metric type.

minVals
object

resource
integer

resourceType
string

(Optional) Resource type.

timeSeriesType
string

topMetric
boolean

unit
string

Metric type unit.

unitLabel
string

(Optional) Label of the y-axis in the graph widget).

{
  "description": "Sample metric please ignore",
  "displayName": "TestMetric",
  "displayUnit": "Percentage (%)",
  "groupName": "system.test.*",
  "metricName": "system.metric.device.test",
  "resourceType": "CPU",
  "type": "Guage",
  "unit": "%",
  "unitLabel": "Percentage (%)"
}

MetricName cannot be null