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

Get Edge Link Metrics

Description

Edge WAN link transport metrics

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/linkStats
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 Required

metrics supported for querying linkStats

Possible values are: bytesTxbytesRxpacketsTxpacketsRxtotalBytestotalPacketsp1BytesRxp1BytesTxp1PacketsRxp1PacketsTxp2BytesRxp2BytesTxp2PacketsRxp2PacketsTxp3BytesRxp3BytesTxp3PacketsRxp3PacketsTxcontrolBytesRxcontrolBytesTxcontrolPacketsRxcontrolPacketsTxbpsOfBestPathRxbpsOfBestPathTxbestJitterMsRxbestJitterMsTxbestLatencyMsRxbestLatencyMsTxbestLossPctRxbestLossPctTxscoreTxscoreRxsignalStrengthstate


string
sortBy Optional

sortBy query param to sort the resultset. Format of sortBy is <ASC | DESC>


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 array of EdgeLinkStatsRecord of type application/json

Request successfully processed

{
	"bestJitterMsRx": 0,
	"bestJitterMsTx": 0,
	"bestLatencyMsRx": 0,
	"bestLatencyMsTx": 0,
	"bestLossPctRx": 0,
	"bestLossPctTx": 0,
	"bpsOfBestPathRx": 0,
	"bpsOfBestPathTx": 0,
	"bytesRx": 0,
	"bytesTx": 0,
	"controlBytesRx": 0,
	"controlBytesTx": 0,
	"controlPacketsRx": 0,
	"controlPacketsTx": 0,
	"link": {
		"_href": "string",
		"alertsEnabled": false,
		"backupState": "UNCONFIGURED",
		"created": "string",
		"displayName": "string",
		"edge": {
			"_href": "string",
			"activationKey": "string",
			"activationKeyExpires": "string",
			"activationState": "UNASSIGNED",
			"activationTime": "string",
			"alertsEnabled": false,
			"bastionState": "UNCONFIGURED",
			"buildNumber": "string",
			"created": "string",
			"customInfo": "string",
			"description": "string",
			"deviceFamily": "string",
			"deviceId": "string",
			"dnsName": "string",
			"edgeState": "NEVER_ACTIVATED",
			"edgeStateTime": "string",
			"endpointPkiMode": "CERTIFICATE_DISABLED",
			"enterprise": {
				"_href": "string",
				"accountNumber": "string",
				"alertsEnabled": false,
				"bastionState": "UNCONFIGURED",
				"city": "string",
				"contactEmail": "string",
				"contactMobile": "string",
				"contactName": "string",
				"contactPhone": "string",
				"country": "string",
				"created": "string",
				"description": "string",
				"domain": "string",
				"endpointPkiMode": "CERTIFICATE_DISABLED",
				"gatewayPool": {
					"_href": "string"
				},
				"lat": 0,
				"locale": "string",
				"logicalId": "string",
				"lon": 0,
				"modified": "string",
				"name": "string",
				"operatorAlertsEnabled": false,
				"postalCode": "string",
				"prefix": "string",
				"state": "string",
				"streetAddress": "string",
				"streetAddress2": "string",
				"timezone": "string"
			},
			"factoryBuildNumber": "string",
			"factorySoftwareVersion": "string",
			"haLastContact": "string",
			"haPreviousState": "UNCONFIGURED",
			"haSerialNumber": "string",
			"haState": "UNCONFIGURED",
			"isLive": false,
			"lastContact": "string",
			"links": [
				{
					"_href": "string"
				}
			],
			"logicalId": "string",
			"lteRegion": "string",
			"modelNumber": "string",
			"modemBuildNumber": "string",
			"modemFirmwareVersion": "string",
			"modified": "string",
			"name": "string",
			"operatorAlertsEnabled": false,
			"platformBuildNumber": "string",
			"platformFirmwareVersion": "string",
			"selfMacAddress": "string",
			"serialNumber": "string",
			"serviceState": "IN_SERVICE",
			"serviceUpSince": "string",
			"site": {
				"_href": "string",
				"city": "string",
				"contactEmail": "string",
				"contactMobile": "string",
				"contactName": "string",
				"contactPhone": "string",
				"country": "string",
				"created": "string",
				"lat": 0,
				"locale": "string",
				"lon": 0,
				"modified": "string",
				"name": "string",
				"postalCode": "string",
				"shippingAddress": "string",
				"shippingAddress2": "string",
				"shippingCity": "string",
				"shippingContactName": "string",
				"shippingCountry": "string",
				"shippingPostalCode": "string",
				"shippingSameAsLocation": false,
				"shippingState": "string",
				"state": "string",
				"streetAddress": "string",
				"streetAddress2": "string",
				"timezone": "string"
			},
			"softwareUpdated": "string",
			"softwareVersion": "string",
			"systemUpSince": "string"
		},
		"interface": "string",
		"internalId": "string",
		"ipAddress": "string",
		"ipV6Address": "string",
		"isp": "string",
		"lastActive": "string",
		"lastEvent": "string",
		"lastEventState": "UNKNOWN",
		"lat": 0,
		"linkMode": "ACTIVE",
		"logicalId": "string",
		"lon": 0,
		"macAddress": "string",
		"modified": "string",
		"netmask": "string",
		"networkSide": "UNKOWN",
		"networkType": "UNKNOWN",
		"operatorAlertsEnabled": false,
		"org": "string",
		"serviceState": "IN_SERVICE",
		"state": "UNKNOWN",
		"userOverride": false
	},
	"name": "string",
	"p1BytesRx": 0,
	"p1BytesTx": 0,
	"p1PacketsRx": 0,
	"p1PacketsTx": 0,
	"p2BytesRx": 0,
	"p2BytesTx": 0,
	"p2PacketsRx": 0,
	"p2PacketsTx": 0,
	"p3BytesRx": 0,
	"p3BytesTx": 0,
	"p3PacketsRx": 0,
	"p3PacketsTx": 0,
	"packetsRx": 0,
	"packetsTx": 0,
	"scoreRx": 0,
	"scoreTx": 0,
	"signalStrength": 0,
	"totalBytes": 0,
	"totalPackets": 0
}
number as float
bestJitterMsRx Optional

number as float
bestJitterMsTx Optional

number as float
bestLatencyMsRx Optional

number as float
bestLatencyMsTx Optional

number as float
bestLossPctRx Optional

number as float
bestLossPctTx Optional

number as float
bpsOfBestPathRx Optional

number as float
bpsOfBestPathTx Optional

number as float
bytesRx Optional

number as float
bytesTx Optional

number as float
controlBytesRx Optional

number as float
controlBytesTx Optional

number as float
controlPacketsRx Optional

number as float
controlPacketsTx Optional

link Optional

string
name Optional

number as float
p1BytesRx Optional

number as float
p1BytesTx Optional

number as float
p1PacketsRx Optional

number as float
p1PacketsTx Optional

number as float
p2BytesRx Optional

number as float
p2BytesTx Optional

number as float
p2PacketsRx Optional

number as float
p2PacketsTx Optional

number as float
p3BytesRx Optional

number as float
p3BytesTx Optional

number as float
p3PacketsRx Optional

number as float
p3PacketsTx Optional

number as float
packetsRx Optional

number as float
packetsTx Optional

number as float
scoreRx Optional

number as float
scoreTx Optional

number as float
signalStrength Optional

number as float
totalBytes Optional

number as float
totalPackets Optional
Errors

Errors

ValidationError
400

ValidationError


UnAuthorized
401

Unauthorized


ResourceNotFoundError
404

Resource not found


RateLimitExceededError
429

Rate Limit Exceeded


InternalServerError
500

Internal server error

Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/linkStats?metrics=string


Feedback

Was this page helpful?