Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Tag Management/ Performing Operations on a CBH Instance Tag
Updated on 2026-11-05 GMT+08:00

Performing Operations on a CBH Instance Tag

Function

This API is used to perform operations on a CBH tag.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/cbs/instance/{resource_id}/tags/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which uniquely identifies a project. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

resource_id

Yes

String

Specifies the resource ID. For details, see Obtaining CBH Instances.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. For details, see Obtaining a User Token.

Constraints

N/A

Range

String type. The value can contain 1 to 28,000 characters.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Action.

  • create: creation

  • delete: deletion

tags

Yes

Array of ResourceTag objects

Tag list.

This parameter is mandatory when the tenant permission is used. For the op_service permission, choose either this field or sys_tags.

sys_tags

No

Array of ResourceTag objects

  • The system tag list.

  • This field is only available to the op_service permission. Choose either this field or tags.

  • _sys_enterprise_project_id is the only resource_tag structure key used in TMS calls.

  • The value is UUID or 0. 0 indicates the default enterprise project.

  • Only create is supported.

Table 4 ResourceTag

Parameter

Mandatory

Type

Description

key

Yes

String

Tag key. The value can contain up to 128 characters.

value

Yes

String

Value. Each value can contain a maximum of 255 characters.

Response Parameters

Status code: 204

None

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Token verification failed.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Permissions required.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Not CBH instances found.

Example Requests

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

Example Responses

None

Status Codes

Status Code

Description

204

A request has succeeded, but that the client does not need to navigate away from its current page.

400

Invalid parameters

401

Unauthorized

403

Forbidden

404

Not Found

500

System error.

Error Codes

See Error Codes.