Creating a VBS Backup

Function

This API is used to create a VBS backup.

If the API is successfully called, the backup task is successfully delivered. You can query the backup status by using the API for Querying Details About a VBS Backup (Native OpenStack API).

URI

  • URI format

    POST /v2/{project_id}/cloudbackups

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    backup

    Yes

    dict

    Backup to be created. For details, see the backup field description.

  • backup field description

    Parameter

    Mandatory

    Type

    Description

    volume_id

    Yes

    string

    ID of the disk to be backed up

    snapshot_id

    No

    string

    Snapshot ID of the disk to be backed up

    name

    Yes

    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. The value is a string of 1 to 64 characters and cannot contain the less-than sign (<) or greater-than sign (>).

    tags

    No

    list<dict>

    List of tags to be configured for the backup resources. For details, see the tag field description.

    extend_param

    No

    map<string,string>

    Additional information for creating the VBS backup. The FullBackup field is supported. If FullBackup is set to true, full backup will be adopted this time. If FullBackup is set to false or the parameter is left blank, incremental backup will be adopted.

    • tag field description

      Parameter

      Mandatory

      Type

      Description

      key

      Yes

      string

      Tag key. A tag key consists of up to 36 characters. A tag key cannot contain non-printable ASCII characters (0-31) and the following special characters: =*<>\,|/

      value

      Yes

      string

      Tag value. A tag value consists of 0 to 43 characters. A tag key cannot contain non-printable ASCII characters (0-31) and the following special characters: =*<>\,|/

    Note

    When you use Instant Restore for the first time and the to-be-restored disk has been backed up before the feature is enabled, you need to perform a full backup on the disk on the console or directly call the API for creating a full backup (POST /v2/{tenant_id}/cloudbackups). After doing this, the disk backups generated through APIs will support this feature.

  • Example request

    {
        "backup": {
            "volume_id": "c68ae7fb-0aa5-4a97-ab01-ed02c5b7e768",
            "snapshot_id": null,
            "name": "backup1",
            "description": "Backup_Demo",
            "tags":[{
                "key":"key",
                "value":"value"
             }],
            "extend_param": {"FullBackup": "true"}
        }
    }
    

Response

  • Parameter description

    Parameter

    Type

    Description

    job_id

    string

    Job ID

    message

    string

    Error message returned after an error occurs

    code

    string

    Error code returned after an error occurs

    For details about error codes, see Error Codes.

  • Example response

    {
    "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
    }
    

    or

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

Status Codes

  • Normal

    200

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

For details, see Error Codes.