Relationship Metrics

Relationship Metrics

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
URI
POST
https://{api_host}/tcsa.host.com/tcsa/api/metrics-management/v1/relationship-metrics
COPY
Request Body
RelationshipMetricRequest of type(s) application/json
Optional

Show optional properties

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

Catalog metric-name to be retrived

array of MetricRelation
relations
Required

Link id to which metrics to be fetched

Authentication
This operation uses the following authentication methods.
Responses
200

Ok

Returns RelationshipMetricResponse of type(s) application/json 
{
    "LINK-AggregatePort-10.107.119.10/5001-LACP<->IF-10.107.117.2/2": {
        "10.107.119.10$Switch$": {
            "value": 0.018179733,
            "interface_name": "AggregatePort-10.107.119.10/5001-LACP"
        },
        "10.107.117.2$Router$": {
            "value": 0.08389807,
            "interface_name": "IF-10.107.117.2/2"
        }
    }
}

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

On This Page
Metrics Operations
GET
Get Metrics
POST
Relationship Metrics