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

Retrieve the volume transfer status for a volume

Contributors
PDFs

GET /svm/migrations/{svm_migration.uuid}/volumes/{volume.uuid}

Introduced In: 9.10

Retrieves the volume transfer status of the specified volume.uuid.

  • vserver migrate show-volume

Parameters

Name Type In Required Description

svm_migration.uuid

string

path

True

Migration UUID

volume.uuid

string

path

True

Volume UUID

transfer_state

string

query

False

Filter by transfer_state

volume.name

string

query

False

Filter by volume.name

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

healthy

boolean

query

False

Filter by healthy

errors.code

string

query

False

Filter by errors.code

errors.message

string

query

False

Filter by errors.message

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

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

self_link

errors

array[errors]

List of transfer errors

healthy

boolean

Indicates whether the volume transfer relationship is healthy.

node

node

Node in the destination cluster where the volume is hosted

svm

svm

SVM information

transfer_state

string

Status of the transfer.

volume

volume

Volume information in the destination cluster
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "transfer_state": "string",
  "volume": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "volume1",
    "uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

13172783

Migrate RDB lookup failed

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
Name Type Description

self

href

errors

Name Type Description

code

string

Argument code

message

string

Message argument

_links

Name Type Description

self

href

node

Node in the destination cluster where the volume is hosted

Name Type Description

_links

_links

name

string

uuid

string

svm

SVM information

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.

volume

Volume information in the destination cluster

Name Type Description

_links

_links

name

string

The name of the volume. This field cannot be specified in a POST or 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.