Querying Resource Shares by Tag

Function

This API is used to query resource shares by tag.

URI

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

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of entries that can be displayed on a page.
offset	No	String	Pagination marker.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

**Table 3** 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 TagFilter objects	A maximum of 20 keys can be queried at a time, and each key can contain a maximum of 20 values. The structure body must be included. The tag key cannot be left blank or be an empty string. Each tag key must be unique, and each tag value for a key must be unique. Resources with all tags listed in tags will be returned. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If no tag filtering criteria is specified, all data is returned.
matches	No	Array of Match objects	Search field. The tag key is the field to be matched, for example, resource_name. The tag value indicates the value to be matched. The key is a fixed dictionary value and cannot contain duplicate keys or unsupported keys. Check whether fuzzy match is required based on the key value. For example, if key is set to resource_name, prefix search is performed. If value is empty, exact match is performed. Most services do not have resources without names. In this case, an empty list is returned. For search by resource_id, exact match is used. Only resource_name is supported currently. More fields will be supported later.

**Table 4** TagFilter
Parameter	Mandatory	Type	Description
key	Yes	String	Identifier or name of the tag key.
values	No	Array of strings	List of values for the tag key.

**Table 5** Match
Parameter	Mandatory	Type	Description
key	Yes	String	Key. Currently, only resource_name is supported. Other key values will be available later.
value	Yes	String	Value. Each value can contain a maximum of 255 characters.

Response Parameters

Status code: 200

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

**Table 7** ResourceDTO
Parameter	Type	Description
resource_id	String	Resource ID.
resource_name	String	Resource name.
tags	Array of Tag objects	List of resource tags.
resource_detail	Object	Resource details.

**Table 8** Tag
Parameter	Type	Description
key	String	Identifier or name of the tag key.
value	String	Tag value. You can set the tag value to an empty string but not to null.

Example Requests

Querying resource shares by tag

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

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

Example Responses

Status code: 200

Request succeeded.

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