[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance

Relationship Metrics

Description

This API is used to show the traffic map between the nodes for given link or cable .This api fetches the metrics CurrentUtilization,InputPacketErrorPct for both the ends for given link,cable.Input for this API is id which is combination of A-End <–> Z-End, where A-End,Z-End are entity names on which metrics are getting collected.

Request

Request

URL

URL


post
https://{api_host}tcsa.host.com/tcsa/api/metrics-management/v1/relationship-metrics
Copy

Request Body

Request Body

RelationshipMetricRequest of mimetype application/json Optional
{
    "metric_name": "CurrentUtilization",
    "relations": [
        {
            "id": "LINK-AggregatePort-10.107.119.10/5001-LACP<->IF-10.107.117.2/2"
        }
    ]
}
string
metric_name Required

Catalog metric-name to be retrived


array of MetricRelation
relations Required

Link id to which metrics to be fetched

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns map of RelationshipMetricValueObject of type application/json
Errors

Errors

401

User authentication failed


403

Access to the requested resource/operation is forbidden


404

Cannot find requested resource


500

Internal server error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"RelationshipMetricRequest":{"metric_name":"CurrentUtilization","relations":[{"id":"LINK-AggregatePort-10.107.119.10/5001-LACP<->IF-10.107.117.2/2"}]},"metric_name":"CurrentUtilization","relations":[{"id":"LINK-AggregatePort-10.107.119.10/5001-LACP<->IF-10.107.117.2/2"}]}' https://{api_host}tcsa.host.com/tcsa/api/metrics-management/v1/relationship-metrics


[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Feedback

Was this page helpful?