Run On Demand Uplink Metrics Test For Uplink
Trigger the on demand underlay metrics measurement test for the given uplinkId in a specified serviceMeshId
Trigger the on demand underlay metrics measurement test for the given uplinkId in a specified serviceMeshId
Request
URI
POST
https://{server}/hybridity/api/interconnect/underlay/uplinksHealth/{uplinkId}
COPY
Path Parameters
string
uplinkId
Required
Uplink Id for which on demand metrics is needed
Query Parameters
string
serviceMesh
Required
ServiceMeshId for which on demand metrics is needed
Authentication
This operation uses the following authentication methods.
Responses
202
Accepted
Returns
UnderlayMetricsTestSuccessResponse
of type(s)
application/json
{
"data": {
"underlayTaskId": "string",
"interconnectEntityId": "string"
},
"warnings": [
{
"message": "string"
}
],
"errors": [
{
"code": "string",
"message": "string"
}
]
}
object
data
Optional
data
array of
object
warnings
Optional
warnings
array of
object
errors
Optional
errors
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
404
Not Found
Returns
IXNotFound
of type(s)
application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
array of
object
errors
Optional
errors
409
Conflict
Returns
IXConflict
of type(s)
application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
array of
object
errors
Optional
errors
500
Internal Server Error
Returns
InternalServerError
of type(s)
application/json
{
"errors": [
{
"code": "string",
"message": "string"
}
]
}
array of
object
errors
Optional
errors
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' https://{api_host}/hybridity/api/interconnect/underlay/uplinksHealth/{uplinkId}
On This Page
Underlay Characterization Operations
GET
Get Pmtu By Uplink Id
GET
Get Pmtu Status By Service Mesh Id
GET
Get Underlay Services
GET
Get Uplinks Overview
GET
Get Uplinks Overview For Uplink Id
GET
Get On Demand Metric For Service Meshes
GET
Get On Demand Metric For Service Mesh Id
POST
Run On Demand Uplink Metrics Test For Service Mesh
POST
Run On Demand Uplink Metrics Test For Uplink
GET
Get Utilization For Uplink Id
GET
Get Underlay Task