Updated on 2026-07-29 GMT+08:00

Querying Number of Resource Shares by Tag

Function

This API is used to query the number of resource shares by tag.

Debugging

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

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, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ram:resourceShares:searchResourceShareCountByTag

Read

-

g:TagKeys

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ram:resourceShares:searchResourceShareCountByTag	Read	-	g:TagKeys	-	-

URI

POST /v1/resource-shares/resource-instances/count

Request Parameters

**Table 1** 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 2** 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 be a duplicate key or unsupported key. 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 options will be available later.

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

**Table 4** Match
Parameter	Mandatory	Type	Description
key	Yes	String	Key. Only resource_name is supported currently. More options will be available later.
value	Yes	String	Value. Each value can contain a maximum of 255 characters.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of records.

Example Requests

Querying the number of resource shares by tag

POST /v1/resource-shares/resource-instances/count

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

Example Responses

Status code: 200

Request succeeded.

{
  "total_count" : 100
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent topic: Tag Management