From 88e10a37f3d09ab45e922cf8cb02ee9195265da2 Mon Sep 17 00:00:00 2001 From: weihongmin1 Date: Tue, 26 Aug 2025 13:35:37 +0000 Subject: [PATCH] VBS API 0805 Version Reviewed-by: Muller, Martin Co-authored-by: weihongmin1 Co-committed-by: weihongmin1 --- docs/vbs/api-ref/ALL_META.TXT.json | 2 +- docs/vbs/api-ref/CLASS.TXT.json | 2 +- docs/vbs/api-ref/en-us_topic_0020237255.html | 195 ++++++++++--------- docs/vbs/api-ref/en-us_topic_0024723797.html | 2 +- 4 files changed, 101 insertions(+), 100 deletions(-) diff --git a/docs/vbs/api-ref/ALL_META.TXT.json b/docs/vbs/api-ref/ALL_META.TXT.json index f0114a5cf..469ca6c5c 100644 --- a/docs/vbs/api-ref/ALL_META.TXT.json +++ b/docs/vbs/api-ref/ALL_META.TXT.json @@ -61,7 +61,7 @@ "node_id":"en-us_topic_0020237255.xml", "product_code":"vbs", "code":"4", - "des":"This API is used to create a VBS backup.URI formatPOST /v2/{project_id}/cloudbackupsPOST /v2/{project_id}/cloudbackupsParameter descriptionParameterMandatoryDescriptionpr", + "des":"This service is available only for users and projects where this service has already been used. For new users, disk backups will be created in a newly created default CBR", "doc_type":"api", "kw":"Creating a VBS Backup,VBS Backups,API Reference", "search_title":"", diff --git a/docs/vbs/api-ref/CLASS.TXT.json b/docs/vbs/api-ref/CLASS.TXT.json index ea853bb5c..a7c6f984e 100644 --- a/docs/vbs/api-ref/CLASS.TXT.json +++ b/docs/vbs/api-ref/CLASS.TXT.json @@ -27,7 +27,7 @@ "code":"3" }, { - "desc":"This API is used to create a VBS backup.URI formatPOST /v2/{project_id}/cloudbackupsPOST /v2/{project_id}/cloudbackupsParameter descriptionParameterMandatoryDescriptionpr", + "desc":"This service is available only for users and projects where this service has already been used. For new users, disk backups will be created in a newly created default CBR", "product_code":"vbs", "title":"Creating a VBS Backup", "uri":"en-us_topic_0020237255.html", diff --git a/docs/vbs/api-ref/en-us_topic_0020237255.html b/docs/vbs/api-ref/en-us_topic_0020237255.html index 298a9faec..92c4a096b 100644 --- a/docs/vbs/api-ref/en-us_topic_0020237255.html +++ b/docs/vbs/api-ref/en-us_topic_0020237255.html @@ -1,23 +1,24 @@

Creating a VBS Backup

-

Function

This API is used to create a VBS backup.

+

This service is available only for users and projects where this service has already been used. For new users, disk backups will be created in a newly created default CBR disk vault.

+

Function

This API is used to create a VBS backup.

URI

  • URI format

    POST /v2/{project_id}/cloudbackups

  • Parameter description -

    Parameter

    +
    - - - - - @@ -26,123 +27,123 @@

    Request

    • Parameter description -

    Parameter

    Mandatory

    +

    Mandatory

    Description

    +

    Description

    project_id

    +

    project_id

    Yes

    +

    Yes

    Project ID

    +

    Project ID

    Parameter

    +
    - - - - - - -

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    backup

    +

    backup

    Yes

    +

    Yes

    dict

    +

    dict

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

    +

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

    Parameter

    +
    - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Parameter

    Mandatory

    +

    Mandatory

    Type

    +

    Type

    Description

    +

    Description

    volume_id

    +

    volume_id

    Yes

    +

    Yes

    string

    +

    string

    ID of the disk to be backed up

    +

    ID of the disk to be backed up

    snapshot_id

    +

    snapshot_id

    No

    +

    No

    string

    +

    string

    Snapshot ID of the disk to be backed up

    +

    Snapshot ID of the disk to be backed up

    name

    +

    name

    Yes

    +

    Yes

    string

    +

    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.

    +

    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

    +

    description

    No

    +

    No

    string

    +

    string

    Backup description. The value is a string of 1 to 64 characters and cannot contain the less-than sign (<) or greater-than sign (>).

    +

    Backup description. The value is a string of 1 to 64 characters and cannot contain the less-than sign (<) or greater-than sign (>).

    tags

    +

    tags

    No

    +

    No

    list<dict>

    +

    list<dict>

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

    +

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

    extend_param

    +

    extend_param

    No

    +

    No

    map<string,string>

    +

    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.

    +

    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

      +
      - - - - - - - - - - - @@ -169,33 +170,33 @@

      Response

      • Parameter description -

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      key

      +

      key

      Yes

      +

      Yes

      string

      +

      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: =*<>\,|/

      +

      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

      +

      value

      Yes

      +

      Yes

      string

      +

      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: =*<>\,|/

      +

      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: =*<>\,|/

      Parameter

      +
      - - - - - - - - - - - @@ -216,80 +217,80 @@

      Status Codes

      • Normal

        200

      • Abnormal -

      Parameter

      Type

      +

      Type

      Description

      +

      Description

      job_id

      +

      job_id

      string

      +

      string

      Job ID

      +

      Job ID

      message

      +

      message

      string

      +

      string

      Error message returned after an error occurs

      +

      Error message returned after an error occurs

      code

      +

      code

      string

      +

      string

      Error code returned after an error occurs

      +

      Error code returned after an error occurs

      For details about error codes, see Error Codes.

      Status Code

      +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/vbs/api-ref/en-us_topic_0024723797.html b/docs/vbs/api-ref/en-us_topic_0024723797.html index a2a41b91c..772b5decf 100644 --- a/docs/vbs/api-ref/en-us_topic_0024723797.html +++ b/docs/vbs/api-ref/en-us_topic_0024723797.html @@ -11,7 +11,7 @@

      Status Code

      Description

      +

      Description

      400 Bad Request

      +

      400 Bad Request

      The server failed to process the request.

      +

      The server failed to process the request.

      401 Unauthorized

      +

      401 Unauthorized

      You must enter the username and password to access the requested page.

      +

      You must enter the username and password to access the requested page.

      403 Forbidden

      +

      403 Forbidden

      You are forbidden to access the requested page.

      +

      You are forbidden to access the requested page.

      404 Not Found

      +

      404 Not Found

      The server could not find the requested page.

      +

      The server could not find the requested page.

      405 Method Not Allowed

      +

      405 Method Not Allowed

      You are not allowed to use the method specified in the request.

      +

      You are not allowed to use the method specified in the request.

      406 Not Acceptable

      +

      406 Not Acceptable

      The response generated by the server could not be accepted by the client.

      +

      The response generated by the server could not be accepted by the client.

      407 Proxy Authentication Required

      +

      407 Proxy Authentication Required

      You must use the proxy server for authentication so that the request can be processed.

      +

      You must use the proxy server for authentication so that the request can be processed.

      408 Request Timeout

      +

      408 Request Timeout

      The request timed out.

      +

      The request timed out.

      409 Conflict

      +

      409 Conflict

      The request could not be processed due to a conflict.

      +

      The request could not be processed due to a conflict.

      500 Internal Server Error

      +

      500 Internal Server Error

      Failed to complete the request because of an internal service error.

      +

      Failed to complete the request because of an internal service error.

      501 Not Implemented

      +

      501 Not Implemented

      Failed to complete the request because the server does not support the requested function.

      +

      Failed to complete the request because the server does not support the requested function.

      502 Bad Gateway

      +

      502 Bad Gateway

      Failed to complete the request because the request is invalid.

      +

      Failed to complete the request because the request is invalid.

      503 Service Unavailable

      +

      503 Service Unavailable

      Failed to complete the request because the service is unavailable.

      +

      Failed to complete the request because the service is unavailable.

      504 Gateway Timeout

      +

      504 Gateway Timeout

      A gateway timeout error occurred.

      +

      A gateway timeout error occurred.

      2025-07-28

      Updated the following content:

      -

      Added the description for error code BackupService.4008.

      +

      Updated section "Creating a VBS Backup".

      2024-10-11