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

Querying All EVS Disk Transfers

Function

This API is used to query all EVS disk transfers of the current tenant.

Calling Method

For details, see Calling APIs.

URI

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

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

The maximum number of query results that can be returned. The value must be an integer greater than 0.

offset

No

Integer

The query offset. All disk transfers after this offset will be queried. The value must be an integer greater than 0 but less than the number of disk transfers.

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

transfers

Array of VolumeTransferSummary objects

The overview of disk transfers.
Table 5 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 6 Link

Parameter

Type

Description

href

String

The corresponding shortcut link.

rel

String

The shortcut link marker name.

Default: next

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error

Error object

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

Example Responses

Status code: 200

OK

{
  "transfers" : [ {
    "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"
    } ]
  }, {
    "id" : "f26c0dee-d20d-4e80-8dee-a8d91b9742a1",
    "name" : "second volume transfer",
    "volume_id" : "673db275-379f-41af-8371-e1652132b4c1",
    "links" : [ {
      "href" : "https://localhost/v2/firstproject/os-volume-transfer/2",
      "rel" : "self"
    }, {
      "href" : "https://localhost/firstproject/os-volume-transfer/2",
      "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