Disk events anomaly detection API - PUT an event

Updates the specified disk event rule.

The request consumes and produces an application/json payload.

This request is an early adopter release and may be changed in non compatible way.

PUT	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/{id} SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/anomalyDetection/diskEvents/{id}

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
id	string	The ID of the disk event rule to be updated.	path	required
body	DiskEventAnomalyDetectionConfig	JSON body of the request. Contains updated disk event rule parameters.	body	optional

Request parameters JSON model

The DiskEventAnomalyDetectionConfig object

Element	Type	Description	Required
metadata	ConfigurationMetadata	Metadata useful for debugging.	optional
id	string	The ID of the disk event rule.	optional
name	string	The name of the disk event rule.	required
enabled	boolean	Disk event rule enabled/disabled.	required
metric	string	The metric to monitor. The metric element can hold these values.	required
threshold	number	The threshold to trigger disk event. A percentage for `LowDiskSpace` or `LowInodes` metrics. In milliseconds for `ReadTimeExceeding` or `WriteTimeExceeding` metrics.	required
samples	integer	The number of samples to evaluate.	required
violatingSamples	integer	The number of samples that must violate the threshold to trigger an event. Must not exceed the number of evaluated samples.	required
diskNameFilter	DiskNameFilter	Narrows the rule usage down to disks, matching the specified criteria.	optional
tagFilters	TagFilter[]	Narrows the rule usage down to the hosts matching the specified tags.	optional

The TagFilter object

A tag-based filter of monitored entities.

Element Type Description Required

context

string

Element	Type	Description	Required
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value. The context element can hold these values.	required
key	string	The key of the tag. Custom tags have the tag value here.	required
value	string	The value of the tag. Not applicable to custom tags.	optional

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

The context element can hold these values.

required

key

string

The key of the tag.

Custom tags have the tag value here.

required

value

string

The value of the tag.

Not applicable to custom tags.

optional

The DiskNameFilter object

Narrows the rule usage down to disks, matching the specified criteria.

Element	Type	Description	Required
operator	string	Comparison operator. The operator element can hold these values.	required
value	string	Value to compare to.	required

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description	Required
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.	optional
clusterVersion	string	DESK server version.	optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "metadata": {
    "configurationVersions": [
      "integer"
    ],
    "clusterVersion": "string"
  },
  "id": "string",
  "name": "string",
  "enabled": true,
  "metric": "LOW_DISK_SPACE",
  "threshold": "number",
  "samples": 10,
  "violatingSamples": 8,
  "diskNameFilter": {
    "operator": "CONTAINS",
    "value": "string"
  },
  "tagFilters": [
    {
      "context": "AWS",
      "key": "string",
      "value": "string"
    }
  ]
}

Possible values

Possible values for the context element in the TagFilter object:

AWS
AWS_GENERIC
AZURE
CLOUD_FOUNDRY
CONTEXTLESS
ENVIRONMENT
GOOGLE_CLOUD
KUBERNETES

Possible values for the operator element in the DiskNameFilter object:

CONTAINS
DOES_NOT_CONTAIN
DOES_NOT_EQUAL
DOES_NOT_START_WITH
EQUALS
STARTS_WITH

Possible values for the metric element in the DiskEventAnomalyDetectionConfig object:

LOW_DISK_SPACE
LOW_INODES
READ_TIME_EXCEEDING
WRITE_TIME_EXCEEDING

Response format

Response parameters JSON model

The EntityShortRepresentation object

The short representation of a DESK entity.

Element	Type	Description
id	string	The ID of the DESK entity.
name	string	The name of the DESK entity.
description	string	A short description of the DESK entity.

{}

Response codes

Code	Description
201	Success. The new disk event rule has been created. The ID of the new disk event rule is returned.
204	Success. The disk event rule has been updated. Response doesn't have a body.
400	Failed. The input is invalid.
403	Failed. The specified ID is reserved for internal use.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

This request is an early adopter release and may be changed in non compatible way.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/anomalyDetection/diskEvents/{id}/validator SaaS https://{your-environment-id}.live.dexp.ae/api/config/v1/anomalyDetection/diskEvents/{id}/validator

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Response codes

Code	Description
204	Validated. The submitted disk event rule is valid. Response doesn't have a body.
400	Failed. The input is invalid.
403	Failed. The specified ID is reserved for internal use.

Example

In this example, the request updates the very slow disk rule we created in the POST request example. It changes the threshold to 180 milliseconds in 9 out of 10 samples.

The API token is passed in the Authorization header.

You can download or copy the example request body to try it out on your own.

Curl

curl -X PUT \
  https://mySampleEnv.live.dexp.ae/api/config/v1/anomalyDetection/diskEvents/fdd83212-9c08-44ba-a0cf-dbb471cd819a \
  -H 'Authorization: Api-token abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "very slow disk",
  "enabled": true,
  "metric": "READ_TIME_EXCEEDING",
  "threshold": 180,
  "samples": 10,
  "violatingSamples": 9,
  "diskNameFilter": {
    "operator": "STARTS_WITH",
    "value": "C"
  },
  "tagFilters": []
}
'

Request URL

https://mySampleEnv.live.dexp.ae/api/config/v1/anomalyDetection/diskEvents/fdd83212-9c08-44ba-a0cf-dbb471cd819a

Request body


        api-examples/config/anomaly-detection/disk-events/put-config.json

Download

{
  "name": "very slow disk",
  "enabled": true,
  "metric": "READ_TIME_EXCEEDING",
  "threshold": 180,
  "samples": 10,
  "violatingSamples": 9,
  "diskNameFilter": {
    "operator": "STARTS_WITH",
    "value": "C"
  },
  "tagFilters": []
}

Response code

204

Result

The updated configuration has the following parameters:

Custom disk events rule - updated