Get Capacity Prediction (2.0)

POST 
/v2.0/api/tenants/:tenant_id/monitor/aiops/forecast

Query request for getting capacity prediction based on type and forecast basis.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Query request for getting capacity prediction based on type and forecast basis

anomaly Forecast[]
The number of sites that will reach high capacity utilization threshold within the next 28 days.
Array [
actual_forecast_date date-time
The forecast date and time.
bw_site_anomaly number
The bandwidth anomaly for the specified time range filter for the site.
forecast_status boolean
The forecast status. True or False.
items ForecastResult[]
The deatils of the forecast results.
Array [
direction object
The direction of traffic.
site string
The site.
wn_path string
The WAN path.
]
name string
Possible values: [CAPACITY_EXCEED_THRESHOLD, ANOMALY, CIRCUIT_CAPACITY_FORECAST, CIRCUIT_UTILIZATION, ANOMALY_SITE_CIRCUIT_DETAILS]
The name of the forecast.
type string
Possible values: [FORECAST_28_DAYS, FORECAST_7_DAYS, CIRCUIT_UTILIZATION_ANOMALY]
The type of forecast.
]
end_time date

The end time of the capacity prediction query. End times need to be specified in ISO8601 UTC format.

filter CapacityPredictionFilter

Filters according to the specifications.

direction string

Possible values: [Ingress, Egress]

Filter by direction of traffic.

site string[]

Filter by site.

wn_path string[]

Filter by WAN path.

forecast Forecast[]
The deatils of the forecast.
Array [
actual_forecast_date date-time
The forecast date and time.
bw_site_anomaly number
The bandwidth anomaly for the specified time range filter for the site.
forecast_status boolean
The forecast status. True or False.
items ForecastResult[]
The deatils of the forecast results.
Array [
direction object
The direction of traffic.
site string
The site.
wn_path string
The WAN path.
]
name string
Possible values: [CAPACITY_EXCEED_THRESHOLD, ANOMALY, CIRCUIT_CAPACITY_FORECAST, CIRCUIT_UTILIZATION, ANOMALY_SITE_CIRCUIT_DETAILS]
The name of the forecast.
type string
Possible values: [FORECAST_28_DAYS, FORECAST_7_DAYS, CIRCUIT_UTILIZATION_ANOMALY]
The type of forecast.
]
forecast_basis string[]

Possible values: [CAPACITY_EXCEED_THRESHOLD, ANOMALY, CIRCUIT_CAPACITY_FORECAST, CIRCUIT_UTILIZATION, ANOMALY_SITE_CIRCUIT_DETAILS]

The forecast basis types. Forecast basis need be to specified according to 2.0 specifications.

forecast_date date

The forecast data.

name string

The name of the capacity prediction query. Maz size = 128.

start_time date

The start time to get the capacity prediction query. Start times need to be specified in ISO8601 UTC format.,

type string

Possible values: [SITE, CIRCUIT]

The type of capacity prediction query. Type need to be specified according to the specifications.

Responses

200

Successful Operation

application/json

Schema

Schema

anomaly Forecast[]
The number of sites that will reach high capacity utilization threshold within the next 28 days.
Array [
actual_forecast_date date-time
The forecast date and time.
bw_site_anomaly number
The bandwidth anomaly for the specified time range filter for the site.
forecast_status boolean
The forecast status. True or False.
items ForecastResult[]
The deatils of the forecast results.
Array [
direction object
The direction of traffic.
site string
The site.
wn_path string
The WAN path.
]
name string
Possible values: [CAPACITY_EXCEED_THRESHOLD, ANOMALY, CIRCUIT_CAPACITY_FORECAST, CIRCUIT_UTILIZATION, ANOMALY_SITE_CIRCUIT_DETAILS]
The name of the forecast.
type string
Possible values: [FORECAST_28_DAYS, FORECAST_7_DAYS, CIRCUIT_UTILIZATION_ANOMALY]
The type of forecast.
]
end_time date

The end time of the capacity prediction query. End times need to be specified in ISO8601 UTC format.

filter CapacityPredictionFilter

Filters according to the specifications.

direction string

Possible values: [Ingress, Egress]

Filter by direction of traffic.

site string[]

Filter by site.

wn_path string[]

Filter by WAN path.

forecast Forecast[]
The deatils of the forecast.
Array [
actual_forecast_date date-time
The forecast date and time.
bw_site_anomaly number
The bandwidth anomaly for the specified time range filter for the site.
forecast_status boolean
The forecast status. True or False.
items ForecastResult[]
The deatils of the forecast results.
Array [
direction object
The direction of traffic.
site string
The site.
wn_path string
The WAN path.
]
name string
Possible values: [CAPACITY_EXCEED_THRESHOLD, ANOMALY, CIRCUIT_CAPACITY_FORECAST, CIRCUIT_UTILIZATION, ANOMALY_SITE_CIRCUIT_DETAILS]
The name of the forecast.
type string
Possible values: [FORECAST_28_DAYS, FORECAST_7_DAYS, CIRCUIT_UTILIZATION_ANOMALY]
The type of forecast.
]
forecast_basis string[]

Possible values: [CAPACITY_EXCEED_THRESHOLD, ANOMALY, CIRCUIT_CAPACITY_FORECAST, CIRCUIT_UTILIZATION, ANOMALY_SITE_CIRCUIT_DETAILS]

The forecast basis types. Forecast basis need be to specified according to 2.0 specifications.

forecast_date date

The forecast data.

name string

The name of the capacity prediction query. Maz size = 128.

start_time date

The start time to get the capacity prediction query. Start times need to be specified in ISO8601 UTC format.,

type string

Possible values: [SITE, CIRCUIT]

The type of capacity prediction query. Type need to be specified according to the specifications.

Example (from schema)

{
  "anomaly": [
    {
      "actual_forecast_date": "2024-07-29T15:51:28.071Z",
      "bw_site_anomaly": 0,
      "forecast_status": true,
      "items": [
        {
          "direction": {},
          "site": "string",
          "wn_path": "string"
        }
      ],
      "name": "CAPACITY_EXCEED_THRESHOLD",
      "type": "FORECAST_28_DAYS"
    }
  ],
  "end_time": "2024-07-29",
  "filter": {
    "direction": "Ingress",
    "site": [
      "string"
    ],
    "wn_path": [
      "string"
    ]
  },
  "forecast": [
    {
      "actual_forecast_date": "2024-07-29T15:51:28.071Z",
      "bw_site_anomaly": 0,
      "forecast_status": true,
      "items": [
        {
          "direction": {},
          "site": "string",
          "wn_path": "string"
        }
      ],
      "name": "CAPACITY_EXCEED_THRESHOLD",
      "type": "FORECAST_28_DAYS"
    }
  ],
  "forecast_basis": [
    "CAPACITY_EXCEED_THRESHOLD"
  ],
  "forecast_date": "2024-07-29",
  "name": "string",
  "start_time": "2024-07-29",
  "type": "SITE"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      },
      {
        "code": "SCHEMA_MISMATCH"
      },
      {
        "code": "START_TIME_GREATER_THAN_END_TIME"
      },
      {
        "code": "MAX_DATAPOINTS_END_TIME"
      }
    ]
  }
}

Loading...