• Volume Backup Service

vbs
  1. Help Center
  2. Volume Backup Service
  3. API Reference
  4. API Description
  5. Backup Policy
  6. Batch Updating or Deleting Tags of a Backup Policy

Batch Updating or Deleting Tags of a Backup Policy

Function

This interface is used to update or delete the tags of a backup policy.

URI

  • URI format

    POST /v2/{project_id}/backuppolicy/{policy_id}/tags/action

  • Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID

    policy_id

    Yes

    Backup policy ID

Request

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    action

    Yes

    string

    Operator (case-sensitive). Possible values are:

    create: indicates creating tags. A tag will be created when no tag with the same key exists.

    update: indicates updating tags. A tag will be created when no tag with the same key exists.

    delete: indicates deleting tags.

    tags

    No

    list<dict>

    List of tags you want to operate

    key

    Yes

    string

    Tag key. It cannot be left null. When action is create or update, the maximum length of a tag key is 36 characters; when action is delete, that is 127 characters. A tag key cannot contain non-printable ASCII characters (0-31) and the following special characters: =*<>\,|/

    value

    No (mandatory when action is set to create and optional when action is set to delete)

    string

    Tag value. When action is create or update, the maximum length of a tag value is 43 characters; when action is delete, that is 255 characters. A tag value can contain only letters, digits, hyphens (-), and underscores (_).

  • Example request
    {
        "action":"delete",
        "tags":[{
            "key":"0f187b65-8d0e-4fc0-9096-3b55d330531e",
            "value":"volume"
            },{
            "key":"0f187b65-8d0e-4fc0-9096-3b55d330531d",
            "value":"volume"
        }]
    }

Response

  • Parameter description

    Parameter

    Type

    Description

    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
    {
        "error": {
            "message": "XXXX",
            "code": "XXX"
        }
    }

Status Codes

  • Normal

    204

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