• Volume Backup Service

vbs
  1. Help Center
  2. Volume Backup Service
  3. API Reference
  4. API Description
  5. Volume Backup Service
  6. Querying Details About a VBS Backup (Native OpenStack API)

Querying Details About a VBS Backup (Native OpenStack API)

Function

This interface is used to query details about a VBS backup.

URI

  • URI format

    GET /v2/{project_id}/backups/{backup_id}

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID

    backup_id

    Yes

    Backup ID

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    backup

    dict

    List of queried backups

    status

    string

    Backup status

    description

    string

    Backup description

    links

    list<dict>

    Backup URL

    availability_zone

    string

    AZ where the backup resides

    volume_id

    string

    Source volume ID of the backup

    fail_reason

    string

    Cause of the backup failure

    id

    string

    Backup ID

    size

    int

    Backup size

    object_count

    int

    Number of objects on OBS for the disk data

    container

    string

    Container of the backup

    name

    string

    Backup name

    created_at

    string

    Backup creation time

    os-bak-tenant-attr:tenant_id

    string

    ID of the project that owns the VBS backup

    service_metadata

    string

    Backup metadata

    updated_at

    string

    Time when the backup was updated

    data_timestamp

    string

    Current time

    has_dependent_backups

    boolean

    Whether a dependent backup exists

    snapshot_id

    string

    ID of the snapshot associated with the backup

    is_incremental

    boolean

    Whether the backup is an incremental backup

  • service_metadata parameter description

    Parameter

    Type

    Description

    DL

    int

    0: non-deduplication and non-compression; 1: deduplication and non-compression; 2: non-deduplication and compression; 3: deduplication and compression If this key is not specified, the value is 0 (non-deduplication and non-compression).

    VK

    string

    Specifies the encryption VK of an encrypted volume. The value is a string of 64 characters.

    bootable

    boolean

    Specifies whether the volume is the boot volume.

    backupurl

    string

    Specifies the backup image ID on the backup system.

    SP

    string

    Specifies the path name of the backup image in the storage unit.

    VMID

    string

    Specifies the ID of the VM to which the backup image belongs.

    ST

    int

    Specifies the backup service type. 0: volume backup; 1: VM backup; 4: volume backup copy, 5: VM backup copy. If this tag does not exist, volume backup is specified.

    BT

    int

    Specifies the backup storage type.

    SS

    int

    Specifies the space saving rate.

    BP

    string

    Specifies the storage unit path.

    CMKID

    string

    Specifies the CMKID of an encrypted volume. The content is UUID and contains 36 characters.

    progress

    int

    Specifies the backup progress.

    CS

    int

    Specifies the total backup data of the chain where the backup is located. The unit is MB.

    VT

    string

    Specifies the production storage volume type.

    OMID

    string

    Specifies the host ID of the job execution node.

    Type

    int

    Specifies the backup type. 1: full backup; 0: incremental backup

    ebk_T_I

    string

    Specifies the job ID of the backup system.

    AT

    float

    Specifies the average rate (Average Throughput). The unit is MB/s. One digit is reserved after the decimal point.

  • description parameter description

    Parameter

    Type

    Description

    DESC

    string

    Describes the backup.

    INC

    int

    Specifies whether the backup is an incremental backup. 1: incremental backup; 0: full backup

  • Example response
    {
    "backup": {
    "status": "error",
    "description": null,
    "links": [
    {
    "href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
    "rel": "self"
    },
    {
    "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
    "rel": "bookmark"
    }
    ],
    "availability_zone": null,
    "volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
    "fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
    "id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
    "size": 1,
    "object_count": null,
    "container": "volumebackups",
    "name": null,
    "created_at": "2013-06-27T08:48:03.000000",
    "os-bak-tenant-attr:tenant_id": "b23b579f08c84228b9b4673c46f0c442",
    "service_metadata": " {\"bootable\": false, \"backupurl\": \"58d94782-6509-45ad-9442-970d2a005050\", \"BackupSize\": 0, \"progress\": \"0\", \"snap_id\": \"665e411f5d87431ca98c199fbd4a64fd\", \"Type\": 0} "
    }
    }

Status Codes

  • Normal

    200

  • Abnormal

    Status Code

    Description

    400 Bad Request

    The server failed to process the request.

    401 Unauthorized

    You must enter the username and password to access the requested page.

    403 Forbidden

    You are forbidden to access the requested page.

    404 Not Found

    The server could not find the requested page.

    405 Method Not Allowed

    You are not allowed to use the method specified in the request.

    406 Not Acceptable

    The response generated by the server could not be accepted by the client.

    407 Proxy Authentication Required

    You must use the proxy server for authentication so that the request can be processed.

    408 Request Timeout

    The request timed out.

    409 Conflict

    The request could not be processed due to a conflict.

    500 Internal Server Error

    Failed to complete the request because of an internal service error.

    501 Not Implemented

    Failed to complete the request because the server does not support the requested function.

    502 Bad Gateway

    Failed to complete the request because the request is invalid.

    503 Service Unavailable

    Failed to complete the request because the service is unavailable.

    504 Gateway Timeout

    A gateway timeout error occurred.

Error Code

For details, see Error Codes.