• Volume Backup Service

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

Creating a VBS Backup (Native OpenStack V3 API)

Function

This interface is used to create a VBS backup.

URI

  • URI format

    POST /v3/{project_id}/backups

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    backup

    Yes

    dict

    Backup to be created

    volume_id

    Yes

    string

    ID of the disk to be backed up

    snapshot_id

    Yes

    string

    Snapshot ID of the disk to be backed up

    name

    No

    string

    Backup name. The value is a string of 1 to 64 characters that can contain digits, letters, underscores (_), and hyphens (-), not starting with auto.

    description

    No

    string

    Backup description

    container

    No

    string

    Backup container. This parameter will be skipped.

    incremental

    No

    boolean

    Whether it is an incremental backup. The value true indicates an incremental backup and false indicates a full backup. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.

    force

    No

    boolean

    Whether to forcibly back up the attached volumes. The value true indicates a forcible backup and false indicates a non-forcible backup.

    project_id

    No

    string

    Project ID

  • Example request
    {    
    	"backup": {        
    		"volume_id": "c5834fe1-577f-462e-9bf3-1b158e1dde9c",        
    		"snapshot_id": "251f910a-a2bd-443e-a77a-90a3dbd26b7b",        
    		"name": "backup1",        
    		"description": "Backup_Demo"    
    	}
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    backup

    dict

    Information about the created backup

    id

    string

    Backup ID

    name

    string

    Backup name

    links

    list<dict>

    Information about the backup URL

    href

    string

    Backup URL

    rel

    string

    Relationship between the query result and href

  • Example response
    {
        "backup": {
            "id": "bb089eba-6b38-41c8-85a4-2b94fad7d570",
            "links": [
                {
                    "href": "https://volume.Region.dc1.domainname.com/v3/648bba9ba87e4b3f8484d0fc60e2e6cc/backups/bb089eba-6b38-41c8-85a4-2b94fad7d570",
                    "rel": "self"
                },
                {
                    "href": "https://volume.Region.dc1.domainname.com/648bba9ba87e4b3f8484d0fc60e2e6cc/backups/bb089eba-6b38-41c8-85a4-2b94fad7d570",
                    "rel": "bookmark"
                }
            ],
            "name": "backup1"
        }
    }

    or

    {
    "badRequest": {
    "code": "XXXX",
    "message": "XXX"
    }
    }

Status Codes

  • Normal

    202

  • 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.