Get Metric Entities
Provides details of the metric type model belonging to one/more domain.
Offset from first result to fetch.
Maximum number of results per page.
Sorting is allowed only on metric_type, domain and sub_domain fields, eg sort_by=metricType desc
Metric type to be fetched.
RRUDomain the metric type belongs to.
5GSub-Domain the metric type belongs to.
3GPPOK
{
"total": 1,
"page_count": 1,
"entity": [
{
"domain": "5G",
"sub_domains": [
"3GPP",
"vRAN"
],
"description": "Metric model for RRU Radio Resource Utilization",
"metricType": "RRU",
"metrics": [
{
"name": "Active_Time_Dl",
"datatype": null,
"description": "the time duration that gNb used to transmit bits to it's serving UEs",
"range": null,
"unit": "ms",
"max": null,
"min": null
},
{
"name": "Active_Time_Ul",
"datatype": null,
"description": "the time duration that gNb used to receive bits from it's serving UEs",
"range": null,
"unit": "ms",
"max": null,
"min": null
}
],
"properties": [
{
"name": "entityName",
"description": "Name of the entity"
},
{
"name": "dataSource",
"description": "Collector Source for metrics"
},
{
"name": "deviceName",
"description": "Name of the device"
},
{
"name": "entityType",
"description": "Entity Type"
},
{
"name": "deviceType",
"description": "Device Type"
}
],
"tags": [
{
"name": "CUCPID",
"description": "CUCP ID"
},
{
"name": "RUID",
"description": "RU ID"
},
{
"name": "DUID",
"description": "DU ID"
},
{
"name": "CellClusterId",
"description": "Cell Cluster Id"
},
{
"name": "kubernetes_namespace",
"description": "kubernetes namespace"
},
{
"name": "address",
"description": "Address"
},
{
"name": "zip",
"description": "Zip code"
},
{
"name": "model",
"description": "Model of the device"
},
{
"name": "city",
"description": "City"
},
{
"name": "customer",
"description": "Customer entity belongs to"
},
{
"name": "address",
"description": "Address"
},
{
"name": "region",
"description": "Region"
},
{
"name": "deviceCoordinates",
"description": "Device coordinates (Lat,Long)"
},
{
"name": "version",
"description": "Version"
},
{
"name": "location",
"description": "Location of the entity"
},
{
"name": "hostname",
"description": "Host name"
},
{
"name": "hypervsr",
"description": "Hypervisor"
}
],
"tco_internal": [
"type",
"colltimestamp",
"instance",
"processedTimestamp"
]
}
]
}Total number of metric entities
Total number of pages in response
Invalid Request sent by the user
{
"errorCode": "string",
"message": "string",
"detailedMessage": "string"
}Error code for the failed request
Short summary of the error occurred
Detailed message with probable solution
User authentication failed
{
"errorCode": "string",
"message": "string",
"detailedMessage": "string"
}Error code for the failed request
Short summary of the error occurred
Detailed message with probable solution
Access to the requested resource/operation is forbidden
{
"errorCode": "string",
"message": "string",
"detailedMessage": "string"
}Error code for the failed request
Short summary of the error occurred
Detailed message with probable solution
Cannot find requested resource
{
"errorCode": "string",
"message": "string",
"detailedMessage": "string"
}Error code for the failed request
Short summary of the error occurred
Detailed message with probable solution
Internal server error
{
"errorCode": "string",
"message": "string",
"detailedMessage": "string"
}Error code for the failed request
Short summary of the error occurred
Detailed message with probable solution