Updated on 2026-08-20 GMT+08:00

Adding Tags to a Key Pair in Batches

Function

This API is used to add tags to a key pair in batches.

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 /v3/{project_id}/keypairs/{resource_id}/tags/create

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

resource_id

Yes

String

Definition

Resource 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

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tags

Yes

Array of TagItem objects

Definition

Tag list, which is the value pairs of tag keys and values.

Constraints

N/A

Range

N/A

Default Value

N/A

sys_tags

No

Array of TagItem objects

Definition

Tag list, which is the value pairs of tag keys and values.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 4 TagItem

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Tag name

Constraints

  • The tag keys of a key pair cannot have duplicate values. A tag key can be used for multiple key pairs.

  • A key pair can have up to 20 tags.

Range

The value can contain 1 to 128 characters and must match the regular expression ^((?!\s)(?!sys)[\p{L}\p{Z}\p{N}_.:=+\-@]*)(?<!\s)$.

Default Value

N/A

value

No

String

Definition

Tag value

Constraints

N/A

Range

The value can contain at most 255 characters and must match the regular expression ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$.

Default Value

N/A

Response Parameters

Status code: 204

None

Example Requests

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

Example Responses

None

Status Codes

Status Code

Description

204

400

Invalid tag parameter.

401

Authorization failed.

403

Insufficient permissions.

404

Resource not found.

500

System error.

Error Codes

See Error Codes.