Create Threshold Profile (v2.1)

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

Create a new threshold profile.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Details of the Threshold profile to be created

description

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

hard_limit_app_metrics StaticAppMetricConfigrequired

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.

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.

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)

tags string[]

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

Responses

200

Successful Operation

application/json

Schema

Schema

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)

{
  "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": "INVALID_JSON_VALUE"
      },
      {
        "code": "PERFMGMT_HARD_LIMIT_APP_METRICS_REQUIRED"
      },
      {
        "code": "PERFMGMT_MAX_INIT_FAILURE_RATE_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_MAX_LATENCY_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_MAX_JITTER_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_MAX_PACKET_LOSS_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_MAX_RTT_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_UDP_TRT_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_LQM"
      },
      {
        "code": "PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_APP_METRICS"
      },
      {
        "code": "PERFMGMT_LQM_APP_OR_SYNTHETIC_PROBE_THREHOLDS_EXPECTED"
      },
      {
        "code": "PERFMGMT_INVALID_CONFIG_IDS_IN_THRESHOLD_PROFILE"
      },
      {
        "code": "PERFMGMT_INVALID_CONFIG_PROTOCOL_IN_THRESHOLD_PROFILE"
      },
      {
        "code": "PERFMGMT_SYSTEM_CIRCUIT_OR_FLOW_THREHOLDS_EXPECTED"
      },
      {
        "code": "PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_SYSTEM_HEALTH_METRICS"
      },
      {
        "code": "PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_CIRCUIT_UTILIZATION_METRICS"
      },
      {
        "code": "PERFMGMT_NON_EMPTY_THRESHOLDS_EXPECTED_FOR_FLOW_METRICS"
      },
      {
        "code": "PERFMGMT_SYNTHETIC_PROBE_JITTER_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_SYNTHETIC_PROBE_LATENCY_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_SYNTHETIC_PROBE_PACKET_LOSS_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_MIN_MOS_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_SYNTHETIC_PROBE_INIT_FAILURE_PCT_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_SYNTHETIC_PROBE_DNS_TXN_FAILURE_PCT_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_NON_EMPTY_THREHOLDS_EXPECTED"
      },
      {
        "code": "PERFMGMT_MUTUALLY_EXCLUSIVE_THRESHOLD_PARAMETERS_PRESENT"
      },
      {
        "code": "PERFMGMT_INVALID_CONFIG_HETEROGENOUS_PROTOCOL"
      }
    ]
  }
}

Loading...