• Native OpenStack API

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

List Backups

Function Description

This interface is used to query volume backup summaries.

Interface Format

Method

URI

Description

GET

/v2/{tenant_id}/backups

Queries volume backup summaries.

Request filter

Parameter

Type

Mandatory

Remarks

offset

Int

No

Specifies the offset.

limit

Int

No

Specifies the limit of the number of returned results. The value is an integer greater than 0.

name

String

No

Specifies the volume backup name. The value is a string of less than 255 characters.

status

String

No

Specifies the volume backup status. The value can be available or error.

volume_id

Uuid

No

Specifies the volume ID corresponding to the volume backup.

Restrictions

N/A

Extension Description

N/A

Request Parameter

N/A

Response Parameter

Parameter

Type

Mandatory

Remarks

id

String

Yes

Specifies the volume backup ID.

links

List(Dict)

Yes

Specifies the volume backup URL.

name

String

No

Specifies the volume backup name.

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.

Request Example

get /v2/b23b579f08c84228b9b4673c46f0c442/backups

Response Example

{
    "backups": [
        {
            "id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
            "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"
                }
            ],
            "name": null
        },
        {
            "id": "b3cf7a16-decc-4beb-8077-682737d94a58",
            "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"
                }
            ],
            "name": null
        }
    ]
}

Error Code

See section Processing Return Code.