Get Edge Health Metrics
Fetch edge system resource metrics
The logicalId
GUID for the target enterprise
The logicalId
GUID for the target edge
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.
Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.
metrics
Request successfully processed
{
"_href": "string",
"total": 0,
"tunnelCount": {
"min": "number",
"max": "number",
"average": "number"
},
"tunnelCountV6": {
"min": "number",
"max": "number",
"average": "number"
},
"memoryPct": {
"min": "number",
"max": "number",
"average": "number"
},
"flowCount": {
"min": "number",
"max": "number",
"average": "number"
},
"cpuPct": {
"min": "number",
"max": "number",
"average": "number"
},
"cpuCoreTemp": {
"min": "number",
"max": "number",
"average": "number"
},
"handoffQueueDrops": {
"min": "number",
"max": "number",
"average": "number"
}
}
_href
total
ValidationError
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string",
"errors": [
{
"message": "string",
"path": "string"
}
]
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Unauthorized
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Resource not found
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Rate Limit Exceeded
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation
Internal server error
{
"code": "string",
"property": "string",
"message": "string",
"displayMessage": "string",
"documentation": "string"
}
A unique error code
The name of the property to which the error applies, if applicable
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
A non-technical description of the error condition
A link to applicable external documentation