Skip to main content

Retrieve a vVol binding

Contributors
PDFs

GET /protocols/san/vvol-bindings/{protocol_endpoint.uuid}/{vvol.uuid}

Introduced In: 9.10

Retrieves a vVol binding.

  • lun bind show

Learn more

Parameters

Name Type In Required Description

protocol_endpoint.uuid

string

path

True

The unique identifier of the class protocol_endpoint LUN.

vvol.uuid

string

path

True

The unique identifier of the class vvol LUN.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

count

integer

The vVol binding between any two specific LUNs is reference counted. When a REST POST is executed for a vVol binding that already exists, the vVol binding reference count is incremented. When a REST DELETE is executed, the vVol binding reference count is decremented. Only when the vVol binding count reaches zero, or the query parameter delete_all_references is supplied, is the vVol binding destroyed.

id

integer

The ONTAP internal identifier assigned to the vVol binding. The bind identifier is unique amongst all class vvol LUNs bound to the same class protocol_endpoint LUN.

This property was included in early releases of the REST API for vVols and is maintained for backward compatibility. See the secondary_id property, which replaces id.

  • example: 1

  • readOnly: 1

  • x-ntap-deprecated: 9.13.1

  • Introduced in: 9.10

  • x-nullable: true

is_optimal

boolean

Indicates if the class protocol_endpoint LUN and the class vvol LUN are on the same cluster node.

protocol_endpoint

protocol_endpoint

The class protocol_endpoint LUN in the vVol binding. Required in POST.

secondary_id

string

The identifier assigned to the vVol binding, known as the secondary LUN ID. The identifier is unique amongst all class vvol LUNs bound to the same class protocol_endpoint LUN.

The format for a secondary LUN ID is 16 hexadecimal digits (zero-filled) followed by a lower case "h".

svm

svm

The SVM in which the vVol binding and its LUNs are located. Required in POST.

vvol

vvol

The class vvol LUN in the vVol binding. Required in POST.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "count": 1,
  "id": 1,
  "is_optimal": 1,
  "protocol_endpoint": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "/vol/volume1/lun1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "secondary_id": "0000D20000010000h",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "vvol": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "/vol/volume1/lun1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

4

The vVol binding was not found.

Also see the table of common errors in the Response body overview section of this documentation.

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

protocol_endpoint

The class protocol_endpoint LUN in the vVol binding. Required in POST.

Name Type Description

_links

_links

name

string

The fully qualified path name of the LUN composed of the "/vol" prefix, the volume name, the (optional) qtree name, and base name of the LUN. Valid in POST and PATCH.

uuid

string

The unique identifier of the LUN.

svm

The SVM in which the vVol binding and its LUNs are located. Required in POST.

Name Type Description

_links

_links

name

string

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

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

vvol

The class vvol LUN in the vVol binding. Required in POST.

Name Type Description

_links

_links

name

string

The fully qualified path name of the LUN composed of the "/vol" prefix, the volume name, the (optional) qtree name, and base name of the LUN. Valid in POST and PATCH.

uuid

string

The unique identifier of the LUN.

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.