Help Center/ Elastic Volume Service/ API Reference/ API/ Standard Snapshot Tag Management/ Adding Tags to a Snapshot Consistency Group
Updated on 2025-11-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Adding Tags to a Snapshot Consistency Group

Function

This API is used to add tags to a snapshot consistency group. Standard snapshots are only supported in some regions. You can check the supported regions on the console.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/snapshot-groups/{snapshot_group_id}/tags/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

snapshot_group_id

Yes

String

Definition

The snapshot consistency group ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of CreateResourceTag objects

Definition

The tag list.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 4 CreateResourceTag

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

The tag key.

Constraints

Tag keys of a resource must be unique.

A tag key can contain a maximum of 36 characters.

Range

Character set: A-Z, a-z, 0-9, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF)

Default Value

N/A

value

Yes

String

Definition

The tag value.

Constraints

A tag value can contain a maximum of 43 characters.

Range

Character set: A-Z, a-z, 0-9, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF)

Default Value

N/A

Response Parameters

Status code: 204

No Content

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error information returned if an error occurs.

Range

N/A
Table 6 Error

Parameter

Type

Description

code

String

Definition

The error code returned if an error occurs.

Range

For details about the error code, see Error Codes.

message

String

Definition

The error message returned if an error occurs.

Range

N/A

Example Requests

POST https://{endpoint}/v5/{project_id}/snapshot-groups/{snapshot_group_id}/tags/create

{
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  }, {
    "key" : "key2",
    "value" : "value3"
  } ]
}

Example Responses

Status code: 400

Bad Request

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

Status Codes

Status Code

Description

204

No Content

400

Bad Request

Error Codes

See Error Codes.