Help Center/ Organizations/ API Reference/ APIs/ Managing Tags/ Querying Resource Tags

Updated on 2025-04-10 GMT+08:00

View PDF

Querying Resource Tags

This API is used to query tags attached to the specified resource.

GET https://{endpoint}/v1/organizations/{resource_type}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
resource_type	Yes	String	Resource type. It can be organizations:policies, organizations:ous, organizations:accounts, or organizations:roots.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tags	Array of TagsDTO objects	A custom key-value pair.

**Table 4** TagsDTO
Parameter	Type	Description
key	String	Key. Each tag key can contain a maximum of 127 Unicode characters and cannot be left blank.
values	Array of strings	List of values. Each value can contain a maximum of 255 Unicode characters.

Querying resource tags

GET https://{endpoint}/v1/organizations/{resource_type}/tags

Status code: 200

Successful

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "velua2" ]
  } ]
}

Status Code	Description
200	Successful

Parent topic: Managing Tags

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel