[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Get Metric Entities
DescriptionProvides details of the metric type model belonging to one/more domain.
Request
URLURL
https://{api_host}tcsa.host.com/v2/catalog/metric-entities
Query Parameters
Query Parameters
array of
string
domain
Optional
Domain the metric type belongs to.
domain example
[
[
"5G"
]
]
integer
limit
Optional
Maximum number of results per page.
array of
string
metric_type
Optional
Metric type to be fetched.
metric_type example
[
[
"RRU"
]
]
integer
offset
Optional
Offset from first result to fetch.
string
sort_by
Optional
Sorting is allowed only on metric_type, domain and sub_domain fields, eg sort_by=metricType desc
array of
string
sub_domains
Optional
Sub-Domain the metric type belongs to.
sub_domains example
[
[
"3GPP"
]
]
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
MetricEntitiesResponse
of type application/json
{
"entity": [
{
"description": "Metric model for RRU Radio Resource Utilization",
"domain": "5G",
"metricType": "RRU",
"metrics": [
{
"datatype": null,
"description": "the time duration that gNb used to transmit bits to it's serving UEs",
"max": null,
"min": null,
"name": "Active_Time_Dl",
"range": null,
"unit": "ms"
},
{
"datatype": null,
"description": "the time duration that gNb used to receive bits from it's serving UEs",
"max": null,
"min": null,
"name": "Active_Time_Ul",
"range": null,
"unit": "ms"
}
],
"properties": [
{
"description": "Name of the entity",
"name": "entityName"
},
{
"description": "Collector Source for metrics",
"name": "dataSource"
},
{
"description": "Name of the device",
"name": "deviceName"
},
{
"description": "Entity Type",
"name": "entityType"
},
{
"description": "Device Type",
"name": "deviceType"
}
],
"sub_domains": [
"3GPP",
"vRAN"
],
"tags": [
{
"description": "CUCP ID",
"name": "CUCPID"
},
{
"description": "RU ID",
"name": "RUID"
},
{
"description": "DU ID",
"name": "DUID"
},
{
"description": "Cell Cluster Id",
"name": "CellClusterId"
},
{
"description": "kubernetes namespace",
"name": "kubernetes_namespace"
},
{
"description": "Address",
"name": "address"
},
{
"description": "Zip code",
"name": "zip"
},
{
"description": "Model of the device",
"name": "model"
},
{
"description": "City",
"name": "city"
},
{
"description": "Customer entity belongs to",
"name": "customer"
},
{
"description": "Address",
"name": "address"
},
{
"description": "Region",
"name": "region"
},
{
"description": "Device coordinates (Lat,Long)",
"name": "deviceCoordinates"
},
{
"description": "Version",
"name": "version"
},
{
"description": "Location of the entity",
"name": "location"
},
{
"description": "Host name",
"name": "hostname"
},
{
"description": "Hypervisor",
"name": "hypervsr"
}
],
"tco_internal": [
"type",
"colltimestamp",
"instance",
"processedTimestamp"
]
}
],
"page_count": 1,
"total": 1
}
integer as int64
page_count
Required
Total number of pages in response
integer as int64
total
Required
Total number of metric entities
Errors
ErrorDetails
400
Invalid Request sent by the user
ErrorDetails
401
User authentication failed
ErrorDetails
403
Access to the requested resource/operation is forbidden
ErrorDetails
404
Cannot find requested resource
ErrorDetails
500
Internal server error
Code Samples
cURL Command
curl https://{api_host}tcsa.host.com/v2/catalog/metric-entities
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
