[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
Get Edge Link Quality Events
DescriptionFetch link quality scores for an Edge
Request
URLURL
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/linkQualityStats
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.
integer
start
Required
Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.
Response
Response
Response BodyResponse Body
200 OK
Returns
array of
LinkQualityMetricsRecord
of type application/json
Request successfully processed
{
"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",
"haMode": "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",
"standbyBuildNumber": "string",
"standbyDeviceId": "string",
"standbyFactoryBuildNumber": "string",
"standbyFactorySoftwareVersion": "string",
"standbyModelNumber": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbySystemUpSince": "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
},
"scoreAfterTrans": 0,
"scoreAfterVideo": 0,
"scoreAfterVoice": 0,
"scoreBeforeTrans": 0,
"scoreBeforeVideo": 0,
"scoreBeforeVoice": 0
}
number as float
scoreAfterTrans
Optional
number as float
scoreAfterVideo
Optional
number as float
scoreAfterVoice
Optional
number as float
scoreBeforeTrans
Optional
number as float
scoreBeforeVideo
Optional
number as float
scoreBeforeVoice
Optional
Errors
ValidationError
400
ValidationError
UnAuthorized
401
Unauthorized
ResourceNotFoundError
404
Resource not found
RateLimitExceededError
429
Rate Limit Exceeded
InternalServerError
500
Internal server error
Code Samples
cURL Command
curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/edges/{edgeLogicalId}/linkQualityStats?start=10
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
