• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Cinder V3 Interfaces
  5. Volume transfer
  6. List volume transfers summaries

List volume transfers summaries

Function Description

This interface is used to query the transfers of a volume.

Interface Format

Method

URI

Description

GET

/v3/{project_id}/os-volume-transfer

Queries the transfers of a volume.

Restrictions

N/A

Extension Description

N/A

Request Parameter

request filter parameters

Parameter

Type

Mandatory

Remarks

limit

int

No

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

offset

int

No

Specifies the offset. If the value is an integer greater than 0 but less than the number of transfers, the system queries all transfers after the offset.

Response Parameter

Parameter

Type

Mandatory

Remarks

links

List< Dict >

Yes

Specifies the link of the volume transfer.

volume_id

String

Yes

Specifies the volume ID.

id

String

Yes

Specifies the transfer ID.

name

String

Yes

Indicates the transfer name.

Request Example

GET https://volume.localdomain.com:8776/v3/5dd0b0056f3d47b6ab4121667d35621a/os-volume-transfer

Response Example

{
    "transfers": [
        {
            "id": "cac5c677-73a9-4288-bb9c-b2ebfb547377",
            "name": "first volume transfer",
            "volume_id": "894623a6-e901-4312-aa06-4275e6321cce",
            "links": [
                {
                    "href": "http://localhost/v2/firstproject/volumes/1",
                    "rel": "self"
                },
                {
                    "href": "http://localhost/firstproject/volumes/1",
                    "rel": "bookmark"
                }
            ]
        },
        {
            "id": "f26c0dee-d20d-4e80-8dee-a8d91b9742a1",
            "name": "second volume transfer",
            "volume_id": "673db275-379f-41af-8371-e1652132b4c1",
            "links": [
                {
                    "href": "http://localhost/v2/firstproject/volumes/2",
                    "rel": "self"
                },
                {
                    "href": "http://localhost/firstproject/volumes/2",
                    "rel": "bookmark"
                }
            ]
        }
    ]
}

Error Code

See section Processing Return Code.