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

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.

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.

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.

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 [
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.
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.
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.
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": [
    {
      "disabled": true,
      "disabled_reason": "string",
      "hard_limit_app_metrics": {
        "max_init_failure_rate": 0,
        "max_rtt": 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
      },
      "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...