Help Center/ Organizations/ API Reference/ APIs/ Managing Tags/ Querying Resource Instances by Resource Type and Tag

Updated on 2024-11-05 GMT+08:00

View PDF

Querying Resource Instances by Resource Type and Tag

Function

This API is used to query the list of resource instances by resource type and tag.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST https://{endpoint}/v1/organizations/{resource_type}/resource-instances/filter

**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** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on a page.
offset	No	String	Pagination marker.

Request Parameters

**Table 3** 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.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
without_any_tag	No	Boolean	If this parameter is set to true, all resources without tags are queried.
tags	No	Array of TagsDTO objects	A maximum of 10 keys can be queried at a time, and each key can contain a maximum of 10 values. The structure body must be included. The tag key cannot be left blank or be an empty string. Each key must be unique, and each value for a key must be unique. Resources that contain all keys and one or multiple values listed in tags will be found and returned. If no tag filtering criteria is specified, all data is returned.
matches	No	Array of Match objects	List of tags you want to attach to the new account.

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

**Table 6** matches
Parameter	Mandatory	Type	Description
key	Yes	String	Key. The value can be policy, organizational-unit, or account.
value	Yes	String	Value. Each value can contain a maximum of 255 Unicode characters.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
resources	Array of ResourceDTO objects	List of resources.
total_count	Integer	Total number of records.

**Table 8** ResourceDTO
Parameter	Type	Description
resource_id	String	Resource ID.
resource_name	String	Resource name.
tags	Array of Match objects	List of resource tags.

**Table 9** Match
Parameter	Type	Description
key	String	Key. The value can be policy, organizational-unit, or account.
value	String	Value. Each value can contain a maximum of 255 Unicode characters.

Example Requests

Querying the list of resource instances by resource type and tag

POST https://{endpoint}/v1/organizations/{resource_type}/resource-instances/filter

{
  "without_any_tag" : true,
  "tags" : [ {
    "key" : "string",
    "values" : [ "string" ]
  } ],
  "matches" : [ {
    "key" : "string",
    "value" : "string"
  } ]
}

Example Responses

Status code: 200

Successful

{
  "resources" : [ {
    "resource_id" : "string",
    "resource_name" : "string",
    "tags" : [ {
      "key" : "string",
      "value" : "string"
    } ]
  } ],
  "total_count" : 0
}