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

Retrieve the lock for a specific UUID

Contributors
PDFs

GET /protocols/locks/{uuid}

Introduced In: 9.10

Retrieves the lock for a specific UUID.

  • vserver locks show

Parameters

Name Type In Required Description

uuid

string

path

True

Lock ID

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

byte_lock

byte_lock

client_address

string

IP address of the client holding the lock.

constituent

boolean

Indicate if volume is contituent or not.

delegation

string

Type of delegation.

interface

interface

node

node

oplock_level

string

The oplock level determines which operations the client may cache locally.

owner_id

string

Owner ID.

path

string

Object path

protocol

string

Type of lock protocol.

share_lock

share_lock

smb

smb

state

string

State of lock.

svm

svm

type

string

Type of lock.

uuid

string

Lock UUID

volume

volume
Example response 
{
  "byte_lock": {
    "length": 10,
    "offset": 100
  },
  "client_address": "0.0.0.0",
  "delegation": "read",
  "interface": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "ip": {
      "address": "10.10.10.7"
    },
    "name": "lif1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "oplock_level": "exclusive",
  "owner_id": "string",
  "protocol": "cifs",
  "share_lock": {
    "mode": "delete_on_close"
  },
  "smb": {
    "connect_state": "connected",
    "open_group_id": "string",
    "open_type": "none"
  },
  "state": "granted",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "type": "byte_range",
  "uuid": "ceeac1b4-8646-4c76-a054-1c96e87594aa",
  "volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "volume1",
    "uuid": "028baa66-41bd-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

byte_lock

Name Type Description

exclusive

boolean

Indicates whether it is an exclusive bytelock.

length

integer

Length of the bytelock starting from the offset.

mandatory

boolean

Indicates whether or not the bytelock is mandatory.

offset

integer

Starting offset for a bytelock.

soft

boolean

Indicates whether it is a soft bytelock.

super

boolean

Indicates whether it is a super bytelock.

href

Name Type Description

href

string

_links

Name Type Description

self

href

ip

IP information

Name Type Description

address

string

IPv4 or IPv6 address

interface

Name Type Description

_links

_links

ip

ip

IP information

name

string

The name of the interface.

uuid

string

The UUID that uniquely identifies the interface.

node

Name Type Description

_links

_links

name

string

uuid

string

share_lock

Name Type Description

mode

string

Types of share lock modes.

soft

boolean

Indicates whether it is a soft share lock.

smb

Name Type Description

connect_state

string

SMB connection state.

open_group_id

string

SMB open group ID.

open_type

string

SMB open type.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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

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.