Skip to main content
A newer release of this product is available.

Retrieve an SVM configured with audit log volumes

Contributors
PDFs

GET /storage/snaplock/audit-logs

Introduced In: 9.7

Retrieves a list of SVMs configured with audit log volumes.

  • snaplock log show

Learn more

Parameters

Name Type In Required Description

log_archive.path

string

query

False

Filter by log_archive.path

log_archive.size

integer

query

False

Filter by log_archive.size

log_archive.expiry_time

string

query

False

Filter by log_archive.expiry_time

log_archive.base_name

string

query

False

Filter by log_archive.base_name

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

log_volume.retention_period

string

query

False

Filter by log_volume.retention_period

log_volume.max_log_size

integer

query

False

Filter by log_volume.max_log_size

log_volume.volume.name

string

query

False

Filter by log_volume.volume.name

log_volume.volume.uuid

string

query

False

Filter by log_volume.volume.uuid

log_files.path

string

query

False

Filter by log_files.path

log_files.size

integer

query

False

Filter by log_files.size

log_files.expiry_time

string

query

False

Filter by log_files.expiry_time

log_files.base_name

string

query

False

Filter by log_files.base_name

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

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

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

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[snaplock_log]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "log_archive": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "base_name": "string",
        "expiry_time": "2058-06-04T19:00:00Z",
        "path": "/snaplock_log/system_logs/20180822_005947_GMT-present",
        "size": "20000"
      },
      "log_files": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "base_name": "string",
          "expiry_time": "2058-06-04T19:00:00Z",
          "path": "/snaplock_log/system_logs/20180822_005947_GMT-present",
          "size": "20000"
        }
      ],
      "log_volume": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "max_log_size": "20971520",
        "retention_period": "P30M",
        "volume": {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "volume1",
          "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
        }
      },
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

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

log_archive

Name Type Description

_links

_links

archive

boolean

Archive the specified SnapLock log file for the given base_name, and create a new log file. If base_name is not mentioned, archive all log files.

base_name

string

Base name of log file

expiry_time

string

Expiry time of the log file in date-time format. Value '9999-12-31T00:00:00Z' indicates infinite expiry time.

path

string

Absolute path of the log file in the volume

size

integer

Size of the log file in bytes

snaplock_log_file

Name Type Description

_links

_links

archive

boolean

Archive the specified SnapLock log file for the given base_name, and create a new log file. If base_name is not mentioned, archive all log files.

base_name

string

Base name of log file

expiry_time

string

Expiry time of the log file in date-time format. Value '9999-12-31T00:00:00Z' indicates infinite expiry time.

path

string

Absolute path of the log file in the volume

size

integer

Size of the log file in bytes

volume

Name Type Description

_links

_links

name

string

The name of the volume.

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

snaplock_log_volume

Name Type Description

_links

_links

max_log_size

integer

Maximum size of log file in bytes

retention_period

string

Specifies the default log record retention period. The retention period value represents a duration and must be specified in the ISO-8601 duration format. The retention period can be in years, months, days, hours, minutes and seconds. A period specified for years, months and days is represented in the ISO-8601 format as "PY", "PM", "PD" respectively. For example "P10Y" represents a duration of 10 years. A duration in hours, minutes and seconds is represented by "PTH", "PTM", and "PTS" respectively. The period string must contain only a single time element i.e. either years, months, days, hours, minutes or seconds. A duration which combines different periods is not supported, example "P1Y10M" is not supported. Apart from the duration specified in the ISO-8601 format, the retention period field also accepts the string "infinite".

volume

volume

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

snaplock_log

Name Type Description

_links

_links

log_archive

log_archive

log_files

array[snaplock_log_file]

log_volume

snaplock_log_volume

svm

svm

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.