Help Center/ Elastic Volume Service/ API Reference/ Cinder API/ Disk Transfer Management/ Accepting an EVS Disk Transfer
Updated on 2024-02-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Accepting an EVS Disk Transfer

Function

This API is used to accept an EVS disk transfer using a transfer ID and an authentication key.

Constraints

The constraints are as follows:

  • Yearly/Monthly disks cannot be transferred.

  • Frozen disks cannot be transferred.

  • Encrypted disks cannot be transferred.

  • Disks having backups and snapshots cannot be transferred.

  • Disks applied with backup policies cannot be transferred.

  • DSS disks cannot be transferred.

  • DESS disks cannot be transferred.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/os-volume-transfer/{transfer_id}/accept

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

The project ID.

For details about how to obtain the project ID, see Obtaining a Project ID.

transfer_id

Yes

String

The transfer ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

The user token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

accept

Yes

CinderAcceptVolumeTransferOption object

The transfer acceptance marker.
Table 4 CinderAcceptVolumeTransferOption

Parameter

Mandatory

Type

Description

auth_key

Yes

String

The authentication key of the disk transfer.

An authentication key will be returned after a disk transfer is created.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

transfer

VolumeTransferSummary object

The transfer information.
Table 6 VolumeTransferSummary

Parameter

Type

Description

id

String

The transfer ID.

links

Array of Link objects

The transfer links.

name

String

The transfer name.

volume_id

String

The disk ID.
Table 7 Link

Parameter

Type

Description

href

String

The corresponding shortcut link.

rel

String

The shortcut link marker name.

Default: next

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.
Table 9 Error

Parameter

Type

Description

code

String

The error code returned if an error occurs.

For details about error codes and their meanings, see Error Codes.

message

String

The error message returned if an error occurs.

Example Requests

Accepting a disk transfer (through the transfer ID and authentication key)

POST https://{endpoint}/v2/{project_id}/os-volume-transfer/{transfer_id}/accept

{
  "accept" : {
    "auth_key" : "9266c59563c84664"
  }
}

Example Responses

Status code: 202

Accepted

{
  "transfer" : {
    "id" : "cac5c677-73a9-4288-bb9c-b2ebfb547377",
    "name" : "first volume transfer",
    "volume_id" : "894623a6-e901-4312-aa06-4275e6321cce",
    "links" : [ {
      "href" : "https://localhost/v2/firstproject/os-volume-transfer/1",
      "rel" : "self"
    }, {
      "href" : "https://localhost/firstproject/os-volume-transfer/1",
      "rel" : "bookmark"
    } ]
  }
}

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

Status Codes

Status Code

Description

202

Accepted

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Disk Transfer Management