Skip to main content

Get Capacity Prediction (v2.0)

POST 

/sdwan/v2.0/api/monitor/aiops/forecast

Get capacity prediction for site v2.0 Note

  • Start and end time need to be specified in ISO8601 UTC format.
  • Forecast basis need be to specified according to 2.0 specifications.
  • Type need to be specified according to the specifications.

Request

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

    Bw Site Anomaly

    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 details of the forecast.

  • Array [
  • actual_forecast_date date-time

    The forecast date and time.

    bw_site_anomaly number

    Bw Site Anomaly

    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

Successful Operation

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

    Bw Site Anomaly

    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 details of the forecast.

  • Array [
  • actual_forecast_date date-time

    The forecast date and time.

    bw_site_anomaly number

    Bw Site Anomaly

    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.

Loading...