• Native OpenStack API

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

List Backups With Details

Function Description

This interface is used to query volume backups.

Interface Format

Method

URI

Description

GET

/v2/{tenant_id}/backups/detail

This interface is used to query volume backups.

request filter parameters

Parameter

Type

Mandatory

Remarks

offset

Int

No

Specifies the offset.

limit

Int

No

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

name

String

No

Specifies a volume backup name, which consists of fewer than 255 characters.

status

String

No

Specifies the volume backup status.

volume_id

Uuid

No

Specifies the volume ID of the volume backup.

Restrictions

N/A

Expanded Interface

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 backup ID.

fail_reason

String

No

Failure Cause

id

Uuid

Yes

backup_id

size

Int

Yes

Specifies the backup size.

object_count

Int

No

Specifies the number of objects on OBS for the volume data.

container

String

Yes

Specifies the container of the volume backup. The default value is volumebackups.

name

String

No

Specifies the volume backup name.

created_at

String

Yes

Specifies the time when the configuration 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

Specifies the service parameters of the volume backup.

backups_links

List

No

Specifies to query the volume backup position. This field is the peer field of backups in the response body. When limit is specified, this field is returned, indicating that information about partial backups is queried.

updated_at

String

No

Specifies the time when the backup was updated.

date_timestamp

String

No

Specifies the current time.

has_dependent_backups

Blooen

No

Specifies whether a dependent backup exists.

snapshot_id

Uuid

No

Specifies the ID of the snapshot associated with the backup.

is_incremental

boolean

No

Specifies whether the backup is an incremental backup.

Request Example

get /v2/b23b579f08c84228b9b4673c46f0c442/backups/detail

Response Example

{
    "backups": [
        {
            "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": "d516f6e178124a8c913f77fd1c90000f", 
            "service_metadata": null,
            "container": "volumebackups",
            "name": null,
            "created_at": "2013-06-27T08:48:03.000000"
        },
        {
            "status": "error",
            "description": null,
            "links": [
                {
                    "href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/80e17946-6e56-46e0-9547-e9ba4f1619bd",
                    "rel": "self"
                },
                {
                    "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/80e17946-6e56-46e0-9547-e9ba4f1619bd",
                    "rel": "bookmark"
                }
            ],
            "availability_zone": null,
            "volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
            "fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
            "id": "80e17946-6e56-46e0-9547-e9ba4f1619bd",
            "size": 1,
            "object_count": null,
"os-bak-tenant-attr:tenant_id": "d516f6e178124a8c913f77fd1c90000f", 
            "service_metadata": null,
            "container": "volumebackups",
            "name": null,
            "created_at": "2013-06-27T08:56:58.000000"
        },
        {
            "status": "error",
            "description": null,
            "links": [
                {
                    "href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
                    "rel": "self"
                },
                {
                    "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
                    "rel": "bookmark"
                }
            ],
            "availability_zone": null,
            "volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
            "fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
            "id": "b3cf7a16-decc-4beb-8077-682737d94a58",
            "size": 1,
            "object_count": null,
"os-bak-tenant-attr:tenant_id": "d516f6e178124a8c913f77fd1c90000f", 
            "service_metadata": null,
            "container": "volumebackups",
            "name": null,
            "created_at": "2013-06-27T08:46:31.000000"
        }
    ]
}

Error Code

See section Processing Return Code.