• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Cinder V2 Interfaces
  5. Backup
  6. Show Backup Details

Show Backup Details

Function Description

This interface is used to query the volume backup.

Interface Format

Method

URI

Description

GET

/v2/{tenant_id}/backups/{backup_id}

This interface is used to query the volume backup.

Restrictions

N/A

Extension Description

N/A

Request Parameter

N/A

Response Parameter

Parameter

Type

Mandatory

Remarks

status

String

Yes

Specifies the backup status.

description

String

No

Specifies the backup description.

links

List(Dict)

Yes

Specifies the backup URL.

availability_zone

String

No

Specifies the AZ to which the backup belongs.

volume_id

Uuid

Yes

Specifies the volume ID.

fail_reason

String

No

Specifies the fail reason.

id

Uuid

Yes

Specifies the backup ID.

size

Int

Yes

Specifies the backup size.

object_count

Int

No

Specifies the count of objects on the object-based storage.

container

String

Yes

Specifies the volume backup container, By default, the value is volumebackups.

name

String

No

Specifies the volume backup name.

created_at

String

Yes

Specifies the date and time when the volume backup was created.

os-bak-tenant-attr:tenant_id

String

Yes

Specifies the ID of the tenant to which the volume backup belongs.

service_metadata

String

Yes

Service parameter of the volume backup.

Request Example

get /v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2

Response Example

{
    "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,
"os-bak-tenant-attr:tenant_id": "5751d8c3f2f6415993ee4326b41630ec",
"service_metadata": "{\"ebk_T_S\": 1, \"bootable\": false, \"backupurl\": \"d0ee2f40-3124-48f0-bf2f-f2638f829eda\", \"BackupSize\": 0, \"progress\": \"0\", \"snap_id\": \"f2557839a784403ca41718e345c65336\", \"Type\": 0, \"ebk_T_I\": \"edbad49d-78a0-444a-9452-c49c777866cf\"}",
        "container": "volumebackups",
        "name": null,
        "created_at": "2013-06-27T08:48:03.000000"
    }
}

Error Code

See section Processing Return Code.