Querying All Disk Transfers

Function

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

URI

  • URI format

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

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    The project ID.

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

  • Request filter parameters

    Parameter

    Type

    Mandatory

    Description

    limit

    Integer

    No

    The maximum number of query results that can be returned.

    The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit.

    offset

    Integer

    No

    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

The following example shows how to query details of the disk transfers whose limit is no more than 50.

  • Example request

    GET https://{endpoint}/v2/{project_id}/os-volume-transfer?limit=50
    

Response

  • Response parameters

    Parameter

    Type

    Description

    transfers

    List<Transfer>

    The list of transfers. For details, see Parameters in the transfers field.

  • Parameters in the transfers field

    Parameter

    Type

    Description

    links

    Array of Objects

    The links of the transfer. See Parameters in the links field.

    volume_id

    String

    The disk ID.

    id

    String

    The transfer ID.

    name

    String

    The transfer name.

  • Parameters in the links field

    Parameter

    Type

    Description

    href

    String

    The corresponding shortcut link.

    rel

    String

    The shortcut link marker name.

    The default value is next.

  • Example response

    {
        "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 Codes

  • Normal

    200

Error Codes

For details, see Error Codes.