Get Enterprise Nni Series
Fetch all Gateway NNI time series data for the target customer
The logicalId
GUID for the target enterprise
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
metrics supported for querying nniStats
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 supported for sorting nniStatsSeries
nnis requested for querying nniStatsSeries. It is a comma-separated string with each nni consisting of gatewayLogicalId and segmentLogicalId separated by "_". For example: 28a8b8db-e7e0-4578-b123-9381ec036c7a_0aea240f-8631-4aea-bbec-cc1e9b2b46df,28a8b8db-e7e0-4578-b123-9381ec036c7a_58f3a933-592a-4233-a292-485a0a3c7dee
Limits the maximum size of the result set.
Request successfully processed
[
{
"series": [
{
"metric": "string",
"startTime": "number",
"tickInterval": "number",
"data": [
{}
],
"total": "number",
"min": "number",
"max": "number"
}
],
"gateway": {
"_href": "string",
"id": "number",
"created": "string",
"networkId": 0,
"enterpriseProxyId": 0,
"siteId": 0,
"activationKey": "string",
"activationState": "string",
"activationTime": "string",
"softwareVersion": "string",
"buildNumber": "string",
"utilization": "number",
"utilizationDetail": {},
"connectedEdges": 0,
"connectedEdgeList": [
{}
],
"dataCenterVpnStates": "string",
"deviceId": "string",
"logicalId": "string",
"name": "string",
"gatewayState": "string",
"alertsEnabled": false,
"description": "string",
"dnsName": "string",
"isLoadBalanced": false,
"privateIpAddress": "string",
"ipAddress": "string",
"ipV6Address": "string",
"lastContact": "string",
"systemUpSince": "string",
"serviceUpSince": "string",
"serviceState": "string",
"bastionState": "string",
"endpointPkiMode": "string",
"handOffDetail": {},
"ipsecGatewayDetail": {},
"modified": "string"
},
"segmentLogicalId": "string",
"vniId": 0
}
]
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