Update Threshold Profile (v2.1)

PUT 
/v2.1/api/tenants/:tenant_id/perfmgmtthresholdprofiles/:profile_id

Update a threshold profile.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

profile_id stringrequired

The threshold profile ID.

application/json

Body

Details of the Threshold profile to be created

circuit_utilization_metrics_thresholds CircuitUtilizationMetricThresholds

Circuit Utilization Metrics Thresholds: Valid

percentage_circuit_utilization integer

The circuit utilization percentage configured for the threshold.

description string

Description: Size(max = 256, error = DESCRIPTION_EXCEEDS_LIMIT: Description length exceeds limit, min = 0)

flow_metrics_thresholds FlowMetricThresholds

Flow Metrics Thresholds: Valid

percentage_flow_utilization integer

The flow utilization percentage configured for the threshold.

hard_limit_app_metrics StaticAppMetricConfigV2N1

Hard Limit App Metrics: Valid

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

Id

lqm_thresholds LQMThresholdConfigV2N1

Lqm Thresholds: Valid

max_jitter integer

Max Jitter

max_latency integer

Max Latency

max_packet_loss integer

Max Packet Loss

min_mos integer

Min Mos

name stringrequired

Name: Required(error = NAME_REQD: Please provide resource name.) Size(max = 128, error = NAME_EXCEEDS_LIMIT: Name of the resource exceeds limit., min = 0)

soft_limit_app_metrics StaticAppMetricConfigV2N1

Soft Limit App Metrics: Valid

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

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 SystemHealthMetricsThresholds

System Health Metrics Thresholds: Valid

cpu_utilization int32

Cpu Utilization

disk_utilization int32

Disk Utilization

memory_utilization int32

Memory Utilization

tags string[]

Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\s]+, required = false)

Responses

200

Successful Operation

application/json

Schema

Schema

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)

{
  "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": "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_CANNOT_UNSET_LQM_THRESHOLD_PROFILE_IN_USE"
      },
      {
        "code": "PERFMGMT_CANNOT_SET_APP_METRICS_APP_FILTER_MISSING"
      },
      {
        "code": "PERFMGMT_DEFAULT_RESOURCE_NAME_CHANGE_NOT_ALLOWED"
      },
      {
        "code": "PERFMGMT_DEFAULT_THRESHOLD_PROFILE_LQM_UNSET_NOT_ALLOWED"
      },
      {
        "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_CPU_UTILIZATION_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_MEMORY_UTILIZATION_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_DISK_UTILIZATION_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_CIRCUIT_UTILIZATION_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_FLOW_METRICS_THRESHOLD_RANGE_INVALID"
      },
      {
        "code": "PERFMGMT_PROFILE_IN_USE_BY_APP_CIRCUIT_HEALTH_RULE"
      },
      {
        "code": "PERFMGMT_PROFILE_IN_USE_BY_SYSTEM_SITE_HEALTH_RULE"
      },
      {
        "code": "PERFMGMT_INVALID_CONFIG_HETEROGENOUS_PROTOCOL"
      }
    ]
  }
}

Loading...