Skip to main content
REST API reference

Retrieve data-entropy statistics for volumes

PDFs

GET /security/anti-ransomware/volume/entropy-stats

Introduced In: 9.17

Retrieves the data-entropy statistics for the volumes.

Parameters

Name Type In Required Description

entropy_stats_type

string

query

False

Filter by entropy_stats_type

volume.uuid

string

query

False

Filter by volume.uuid

volume.name

string

query

False

Filter by volume.name

data_written_in_bytes

integer

query

False

Filter by data_written_in_bytes

duration

string

query

False

Filter by duration

encryption_percentage

integer

query

False

Filter by encryption_percentage

timestamp

string

query

False

Filter by timestamp

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_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

next

href

self

href

_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

records

Volume data-entropy statistics derived from block analysis.

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

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.