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

Performing Operations on a CBH Instance Tag

Function

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

For details about how to obtain the project ID, see "Obtaining a Project ID".

resource_id

Yes

String

Resource ID. Obtain its value by calling the list API.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained 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 the Token of an IAM User."

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Action.

  • create

  • delete

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

System tag list.

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

Currently, TMS invokes only one resource_tag structure. The key is fixed as _sys_enterprise_project_id.

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

Currently, 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

Tag value. A maximum of 255 characters are allowed for a tag value.

Response Parameters

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Failed to verify the token.

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.