Help Center/ Host Security Service/ API Reference/ API Description/ Tag Management/ Querying All Tags Used in the Current Project of a Tenant
Updated on 2026-04-03 GMT+08:00

Querying All Tags Used in the Current Project of a Tenant

Function

This API is used to query all used tags in the current project of a tenant.

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

GET /v5/{project_id}/{resource_type}/tags

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

resource_type

Yes

String

Definition

Resource type defined by TMS. When HSS calls the API, the resource type is hss.

Constraints

N/A

Range

The value contains 1 to 64 characters.

Default Value

hss

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

tags

Array of MultiValueTagInfo objects

Tag information.

Table 4 MultiValueTagInfo

Parameter

Type

Description

key

String

Definition

Tag key.

Constraints

N/A

Range

The value contains 1 to 128 characters.

Default Value

N/A

values

Array of strings

Definition

List of tag values.

Constraints

N/A

Range

Each value contains 1 to 256 characters.

Default Value

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "tags" : [ {
    "key" : "The tag key.",
    "values" : [ "Label value 1", "Label value 2" ]
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.