Skip to main content
REST API reference

Retrieve a data-entropy statistic for a volume

PDFs

GET /security/anti-ransomware/volume/entropy-stats/{volume.uuid}/{entropy_stats_type}/{timestamp}

Introduced In: 9.17

Retrieves a data-entropy statistic for the volumes.

Parameters

Name Type In Required Description

volume.uuid

string

path

True

The UUID of the volume.

entropy_stats_type

string

path

True

The type of entropy statistics.

  • enum: ["sub_hourly", "hourly", "daily", "high_enc_pct"]

timestamp

string

path

True

The timestamp of the statistics.

  • format: date-time

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

data_written_in_bytes

integer

The amount of data written.

duration

string

The duration of the interval associated with this statistic. The duration is represented in ISO-8601 standard format.

encryption_percentage

integer

The percentage of data that is encrypted.

entropy_stats_type

string

Volume metrics are retrieved based on this statistic type.

timestamp

string

Start time in date-time format.

volume

volume
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "data_written_in_bytes": 0,
  "duration": "PT15M",
  "encryption_percentage": 0,
  "entropy_stats_type": "string",
  "timestamp": "string",
  "volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

volume

Name Type Description

_links

_links

name

string

The name of the volume. This field cannot be specified in a PATCH method.

uuid

string

Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.

  • example: 028baa66-41bd-11e9-81d5-00a0986138f7

  • Introduced in: 9.6

  • x-nullable: true

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.