Updated on 2022-11-02 GMT+08:00

Querying Details of a Disk Transfer

Function

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

URI

  • URI format

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

  • 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.

    transfer_id

    Yes

    The transfer ID.

Request

  • Example request
    GET  https://{endpoint}/v2/{project_id}/os-volume-transfer/cac5c677-73a9-4288-bb9c-b2ebfb547377

Response

  • Response parameters

    Parameter

    Type

    Description

    transfer

    Object

    The transfer details. For details, see Parameters in the transfer field.

  • Parameters in the transfer field

    Parameter

    Type

    Description

    links

    Array of Objects

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

    created_at

    String

    The time when the transfer was created.

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

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

  • Normal

    200

Error Codes

For details, see Error Codes.