Query Performance Policy Threshold Profiles (v2.1)

POST 
/v2.1/api/tenants/:tenant_id/perfmgmtthresholdprofiles/query

Query the DB for the limit number of tenant level threshold profiles that match query parameters.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Query Details for Threshold profile

circuit_utilization_metrics_thresholds CircuitUtilizationMetricThresholds

The circuit utilization metrics thresholds.

percentage_circuit_utilization integer

The circuit utilization percentage configured for the threshold.

description

The description of the threshold profile. Max size = 256.

flow_metrics_thresholds FlowMetricThresholds

The flow 4metrics thresholds.

percentage_flow_utilization integer

The flow utilization percentage configured for the threshold.

hard_limit_app_metrics StaticAppMetricConfigV2N1

The hard limits set for the app metrics.

max_init_failure_rate integer

Max Init Failure Rate: Range(max = 100L, message = PERFMGMT_MAX_INIT_FAILURE_RATE_THRESHOLD_RANGE_INVALID, min = 0L)

max_rtt integer

Max Rtt: Range(max = 500L, message = PERFMGMT_MAX_RTT_THRESHOLD_RANGE_INVALID, min = 0L)

udp_trt integer

Udp Trt

id string

The ID of the threshold profile.

lqm_thresholds LQMThresholdConfigV2N1

Details of the LQM threshold configurations.

max_jitter integer

Max Jitter

max_latency integer

Max Latency

max_packet_loss integer

Max Packet Loss

min_mos integer

Min Mos

name stringrequired

The name of the profile. Max size = 128.

soft_limit_app_metrics StaticAppMetricConfigV2N1

The soft limits set for the app metrics.

max_init_failure_rate integer

Max Init Failure Rate: Range(max = 100L, message = PERFMGMT_MAX_INIT_FAILURE_RATE_THRESHOLD_RANGE_INVALID, min = 0L)

max_rtt integer

Max Rtt: Range(max = 500L, message = PERFMGMT_MAX_RTT_THRESHOLD_RANGE_INVALID, min = 0L)

udp_trt integer

Udp Trt

synthetic_probe_thresholds SyntheticProbeThresholds

The synthetic probe thresholds.

dns_txn_failure_pct SyntheticProbeThreshold

The DNS transaction failure percentage.

probe_config_id string

The probe config ID.

value integer

The threshold value.

init_failure_pct SyntheticProbeThreshold

The init failure percentage.

probe_config_id string

The probe config ID.

value integer

The threshold value.

jitter SyntheticProbeThreshold

The jitter value.

probe_config_id string

The probe config ID.

value integer

The threshold value.

latency SyntheticProbeThreshold

The latency value.

probe_config_id string

The probe config ID.

value integer

The threshold value.

packet_loss SyntheticProbeThreshold

The packet loss value.

probe_config_id string

The probe config ID.

value integer

The threshold value.

system_health_metrics_thresholds SystemHealthMetricsThresholds

The system health metrics thresholds.

cpu_utilization int32

Cpu Utilization

disk_utilization int32

Disk Utilization

memory_utilization int32

Memory Utilization

tags string[]

A information field that can be added to identify the profile. Maximum 10 unique tags.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

tenant_id string

The tenant ID.

total_count int64

Total number.

items PerfMgmtThresholdProfileV2N1[]
Array [
circuit_utilization_metrics_thresholds CircuitUtilizationMetricThresholds
The circuit utilization metrics thresholds.
percentage_circuit_utilization integer
The circuit utilization percentage configured for the threshold.
description
The description of the threshold profile. Max size = 256.
flow_metrics_thresholds FlowMetricThresholds
The flow 4metrics thresholds.
percentage_flow_utilization integer
The flow utilization percentage configured for the threshold.
hard_limit_app_metrics StaticAppMetricConfigV2N1
The hard limits set for the app metrics.
max_init_failure_rate integer
Max Init Failure Rate: Range(max = 100L, message = PERFMGMT_MAX_INIT_FAILURE_RATE_THRESHOLD_RANGE_INVALID, min = 0L)
max_rtt integer
Max Rtt: Range(max = 500L, message = PERFMGMT_MAX_RTT_THRESHOLD_RANGE_INVALID, min = 0L)
udp_trt integer
Udp Trt
id string
The ID of the threshold profile.
lqm_thresholds LQMThresholdConfigV2N1
Details of the LQM threshold configurations.
max_jitter integer
Max Jitter
max_latency integer
Max Latency
max_packet_loss integer
Max Packet Loss
min_mos integer
Min Mos
name stringrequired
The name of the profile. Max size = 128.
soft_limit_app_metrics StaticAppMetricConfigV2N1
The soft limits set for the app metrics.
max_init_failure_rate integer
Max Init Failure Rate: Range(max = 100L, message = PERFMGMT_MAX_INIT_FAILURE_RATE_THRESHOLD_RANGE_INVALID, min = 0L)
max_rtt integer
Max Rtt: Range(max = 500L, message = PERFMGMT_MAX_RTT_THRESHOLD_RANGE_INVALID, min = 0L)
udp_trt integer
Udp Trt
synthetic_probe_thresholds SyntheticProbeThresholds
The synthetic probe thresholds.
dns_txn_failure_pct SyntheticProbeThreshold
The DNS transaction failure percentage.
probe_config_id string
The probe config ID.
value integer
The threshold value.
init_failure_pct SyntheticProbeThreshold
The init failure percentage.
probe_config_id string
The probe config ID.
value integer
The threshold value.
jitter SyntheticProbeThreshold
The jitter value.
probe_config_id string
The probe config ID.
value integer
The threshold value.
latency SyntheticProbeThreshold
The latency value.
probe_config_id string
The probe config ID.
value integer
The threshold value.
packet_loss SyntheticProbeThreshold
The packet loss value.
probe_config_id string
The probe config ID.
value integer
The threshold value.
system_health_metrics_thresholds SystemHealthMetricsThresholds
The system health metrics thresholds.
cpu_utilization int32
Cpu Utilization
disk_utilization int32
Disk Utilization
memory_utilization int32
Memory Utilization
tags string[]
A information field that can be added to identify the profile. Maximum 10 unique tags.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "circuit_utilization_metrics_thresholds": {
        "percentage_circuit_utilization": 0
      },
      "flow_metrics_thresholds": {
        "percentage_flow_utilization": 0
      },
      "hard_limit_app_metrics": {
        "max_init_failure_rate": 0,
        "max_rtt": 0,
        "udp_trt": 0
      },
      "id": "string",
      "lqm_thresholds": {
        "max_jitter": 0,
        "max_latency": 0,
        "max_packet_loss": 0,
        "min_mos": 0
      },
      "name": "string",
      "soft_limit_app_metrics": {
        "max_init_failure_rate": 0,
        "max_rtt": 0,
        "udp_trt": 0
      },
      "synthetic_probe_thresholds": {
        "dns_txn_failure_pct": {
          "probe_config_id": "string",
          "value": 0
        },
        "init_failure_pct": {
          "probe_config_id": "string",
          "value": 0
        },
        "jitter": {
          "probe_config_id": "string",
          "value": 0
        },
        "latency": {
          "probe_config_id": "string",
          "value": 0
        },
        "packet_loss": {
          "probe_config_id": "string",
          "value": 0
        }
      },
      "system_health_metrics_thresholds": {
        "cpu_utilization": 0,
        "disk_utilization": 0,
        "memory_utilization": 0
      },
      "tags": [
        "string"
      ]
    }
  ]
}

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": "BAD_QUERY_REQUEST"
      }
    ]
  }
}

Loading...