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

Querying the Tag Information of a CBH Instance

Function

This API is used to query the tag information of a CBH instance.

URI

GET /v2/{project_id}/cbs/instance/{resource_id}/tags

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of ResourceTag objects

Tag list.

Table 4 ResourceTag

Parameter

Type

Description

key

String

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

value

String

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

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Incorrect request parameters.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Failed to verify the token.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Permissions required.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Not CBH instances found.

Example Requests

None

Example Responses

Status code: 200

Show ResourceIdTags Success

{
  "tags" : [ {
    "key" : "1",
    "value" : "2"
  } ]
}

Status Codes

Status Code

Description

200

Show ResourceIdTags Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.