• Volume Backup Service

vbs
  1. Help Center
  2. Volume Backup Service
  3. API Reference
  4. API Description
  5. Volume Backup Service
  6. Querying Summary Information About VBS Backups (Native OpenStack V3 API)

Querying Summary Information About VBS Backups (Native OpenStack V3 API)

Function

This interface is used to query summary information about a VBS backup.

URI

  • URI format

    GET /v3/{project_id}/backups

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID

  • Request filter parameter description

    Parameter

    Mandatory

    Type

    Description

    name

    No

    string

    Name of the backup to be queried. This parameter is used to query the backups whose names are specified character strings.

    status

    No

    string

    Status of the backup to be queried. This parameter is used to query the backups in a specified state. The value can be available, error, restoring, creating, deleting, or error_deleting.

    offset

    No

    int

    Offset of the queried information

    limit

    No

    int

    Maximum number of query results that can be returned

    volume_id

    No

    string

    Disk ID of the backup to be queried. It is used to query the backups for specific disks.

    with_count

    No

    boolean

    The query result contains the count field whose default value is False. This field is first available in version 3.45.

    name~

    No

    string

    Fuzzy query by backup name. This parameter is added in version 3.31.

    status~

    No

    string

    Fuzzy query by backup status. This parameter is added in version 3.31.

    volume_id~

    No

    string

    Fuzzy query by disk ID. This parameter is added in version 3.31.

    NOTE:

    If the version features such as with_count, name~, status~, and volume_id~ are used, add Openstack-Api-Version": volume 3.45 (3.45 is the version number) to the header when requesting the URL.

  • Example request
    GET /v3/{project_id}/backups?name=backup&status=error&limit=10&volume_id=7d7c6fbe-d7ee-4b4d-8bae-bdd08b5604bb

Request

None

Response

  • Parameter description

    Parameter

    Type

    Description

    backups

    list<dict>

    List of queried backups

    id

    string

    Backup ID

    links

    list<dict>

    Backup URL

    name

    string

    Backup name

    backups_links

    list<dict>

    Specifies that only part of a tenant's backup information is queried, such as query by page with the limit table specified and when the number of backups exceeds 1000.

    href

    string

    Specifies that the URL of the last backup is queried.

    rel

    string

    Relationship between the query result and href. The value next indicates that some backups are not obtained.

    count

    int

    Number of returned items. This parameter is first available in the 3.45 version.

  • Example response
    {
    "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
    }
    ],
    "backups_links": [
        {
          "href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups?limit=1&offset=1&marker=b3cf7a16-decc-4beb-8077-682737d94a58",
          "rel": "next"
        }
      ]
    }

Status Codes

  • Normal

    200

  • Abnormal

    Status Codes

    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.