Query Tenant Level Threshold Profiles (v2.0)

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

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

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Query Details for Threshold profile

circuit_utilization_metrics_thresholds CircuitUtilizationMetricThresholds

Circuit Utilization Metrics Thresholds: Valid

percentage_circuit_utilization integer

The circuit utilization percentage configured for the threshold.

description

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

disabled boolean

Lists if the threshold profiles are disabled.

disabled_reason string

Reason the threshold profile is disabled.

flow_metrics_thresholds FlowMetricThresholds

Flow Metrics Thresholds: Valid

percentage_flow_utilization integer

The flow utilization percentage configured for the threshold.

hard_limit_app_metrics StaticAppMetricConfig

The hard limits set for the app metrics.

max_init_failure_rate integer

The max init failure rate threshold. Max = 100L.

max_rtt integer

The max rtt threshold range. Max = 500L.

udp_trt integer

Udp Trt: Range(max = 500L, message = PERFMGMT_UDP_TRT_THRESHOLD_RANGE_INVALID, min = 0L)

id string

The ID of the threshold profile.

inactive boolean

Lists if the threshold profile is inactive.

inactive_reason string

Reason the threshold profile is inactive.

is_default boolean

The default threshold.

lqm_thresholds LQMThresholdConfig

Details of the LQM threshold configurations.

max_jitter integer

The max jitter threshold range. Max = 100L.

max_latency integer

The max latency threshold range. Max = 500L.

max_packet_loss integer

The max packet loss threshold range. Max = 20L.

name stringrequired

The name of the profile. Max size = 128.

region string

The region of the site.

soft_limit_app_metrics StaticAppMetricConfig

The soft limits set for the app metrics.

max_init_failure_rate integer

The max init failure rate threshold. Max = 100L.

max_rtt integer

The max rtt threshold range. Max = 500L.

udp_trt integer

Udp Trt: Range(max = 500L, message = PERFMGMT_UDP_TRT_THRESHOLD_RANGE_INVALID, min = 0L)

synthetic_probe_thresholds SyntheticProbeThresholds

Synthetic Probe Thresholds: Valid

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 SystemHealthMetricThresholds

System Health Metrics Thresholds: Valid

cpu_utilization integer

The CPU utilization threshold range.

disk_utilization integer

The disk utilization threshold range.

memory_utilization integer

The memory utilization threshold range.

tags string[]

A information field that can be added to identify the profile. Maximum 10 unique tags of length 1024 each are allowed.

tenant_id stringrequired

Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)

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 PerfMgmtThresholdProfile[]
Array [
circuit_utilization_metrics_thresholds CircuitUtilizationMetricThresholds
Circuit Utilization Metrics Thresholds: Valid
percentage_circuit_utilization integer
The circuit utilization percentage configured for the threshold.
description
The description of the threshold profile. Max size = 256.
disabled boolean
Lists if the threshold profiles are disabled.
disabled_reason string
Reason the threshold profile is disabled.
flow_metrics_thresholds FlowMetricThresholds
Flow Metrics Thresholds: Valid
percentage_flow_utilization integer
The flow utilization percentage configured for the threshold.
hard_limit_app_metrics StaticAppMetricConfig
The hard limits set for the app metrics.
max_init_failure_rate integer
The max init failure rate threshold. Max = 100L.
max_rtt integer
The max rtt threshold range. Max = 500L.
udp_trt integer
Udp Trt: Range(max = 500L, message = PERFMGMT_UDP_TRT_THRESHOLD_RANGE_INVALID, min = 0L)
id string
The ID of the threshold profile.
inactive boolean
Lists if the threshold profile is inactive.
inactive_reason string
Reason the threshold profile is inactive.
is_default boolean
The default threshold.
lqm_thresholds LQMThresholdConfig
Details of the LQM threshold configurations.
max_jitter integer
The max jitter threshold range. Max = 100L.
max_latency integer
The max latency threshold range. Max = 500L.
max_packet_loss integer
The max packet loss threshold range. Max = 20L.
name stringrequired
The name of the profile. Max size = 128.
region string
The region of the site.
soft_limit_app_metrics StaticAppMetricConfig
The soft limits set for the app metrics.
max_init_failure_rate integer
The max init failure rate threshold. Max = 100L.
max_rtt integer
The max rtt threshold range. Max = 500L.
udp_trt integer
Udp Trt: Range(max = 500L, message = PERFMGMT_UDP_TRT_THRESHOLD_RANGE_INVALID, min = 0L)
synthetic_probe_thresholds SyntheticProbeThresholds
Synthetic Probe Thresholds: Valid
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 SystemHealthMetricThresholds
System Health Metrics Thresholds: Valid
cpu_utilization integer
The CPU utilization threshold range.
disk_utilization integer
The disk utilization threshold range.
memory_utilization integer
The memory utilization threshold range.
tags string[]
A information field that can be added to identify the profile. Maximum 10 unique tags of length 1024 each are allowed.
tenant_id stringrequired
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
]

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
      },
      "disabled": true,
      "disabled_reason": "string",
      "flow_metrics_thresholds": {
        "percentage_flow_utilization": 0
      },
      "hard_limit_app_metrics": {
        "max_init_failure_rate": 0,
        "max_rtt": 0,
        "udp_trt": 0
      },
      "id": "string",
      "inactive": true,
      "inactive_reason": "string",
      "is_default": true,
      "lqm_thresholds": {
        "max_jitter": 0,
        "max_latency": 0,
        "max_packet_loss": 0
      },
      "name": "string",
      "region": "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"
      ],
      "tenant_id": "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...