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

Querying Details of an EVS Disk Transfer

Function

This API is used to query the details of an EVS disk transfer, including the transfer creation time, transfer ID, and transfer name.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/os-volume-transfer/{transfer_id}

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

transfer

VolumeTransfer object

The details of the disk transfer.
Table 4 VolumeTransfer

Parameter

Type

Description

created_at

String

The time when the transfer was created.

Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

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 5 Link

Parameter

Type

Description

href

String

The corresponding shortcut link.

rel

String

The shortcut link marker name.

Default: next

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error

Error object

The error message returned if an error occurs.
Table 7 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

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

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

Example Responses

Status code: 200

OK

{
  "transfer" : {
    "id" : "cac5c677-73a9-4288-bb9c-b2ebfb547377",
    "created_at" : "2015-02-25T03:56:53.081642",
    "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

200

OK

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Disk Transfer Management