Updated on 2026-09-21 GMT+08:00

Querying Key Tags

This API is used to query key tags.

For details, see Calling APIs.

GET /v1.0/{project_id}/kms/{key_id}/tags

**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
key_id	Yes	String	Definition Key ID Constraints The value must be a 36-byte ID. The value must match the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Range N/A Default Value N/A

**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

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tags	Array of TagItem objects	Definition Tag list, which is the value pairs of tag keys and values. Range N/A
sys_tags	Array of TagItem objects	Definition System tag list, which is the value pairs of key and value. Range N/A
existTagsNum	Integer	Definition Number of key tags Range N/A

**Table 4** TagItem
Parameter	Type	Description
key	String	Definition Tag key Range N/A
value	String	Definition Tag value Range N/A

None

Status code: 200

Request succeeded.

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

Status Code	Description
200	Request succeeded.