[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform

Get Edge Health Metrics

Description

Fetch edge system resource metrics

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/healthStats
Copy

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


string
edgeLogicalId Required

The logicalId GUID for the target edge


Query Parameters

Query Parameters

integer
end Optional

Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.


string
include Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.


string
metrics Optional

integer
start Optional

Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.


Response

Response

Response Body

Response Body

200 OK returns EdgeHealthStatsMetricsSchema of type application/json

Request successfully processed

{
	"_href": "string",
	"cpuCoreTemp": {
		"average": 0,
		"max": 0,
		"min": 0
	},
	"cpuPct": {
		"average": 0,
		"max": 0,
		"min": 0
	},
	"flowCount": {
		"average": 0,
		"max": 0,
		"min": 0
	},
	"handoffQueueDrops": {
		"average": 0,
		"max": 0,
		"min": 0
	},
	"memoryPct": {
		"average": 0,
		"max": 0,
		"min": 0
	},
	"total": 0,
	"tunnelCount": {
		"average": 0,
		"max": 0,
		"min": 0
	},
	"tunnelCountV6": {
		"average": 0,
		"max": 0,
		"min": 0
	}
}
string
_href Optional






integer
total Optional


Errors

Errors

400

ValidationError


401

Unauthorized


404

Resource not found


429

Rate Limit Exceeded


500

Internal server error

Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/healthStats


Feedback

Was this page helpful?