Updated on 2026-08-20 GMT+08:00

Querying the Number of Key Pair Instances

This API is used to query key pair instances, filter key pairs by tag, and return the number of key pairs.

For details, see Calling APIs.

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, no identity policy-based permission required for calling this API.

POST /v3/{project_id}/keypairs/resource-instances/count

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

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
tags	No	Array of Tag objects	Definition Tag list, which is the value pairs of tag keys and values. There can be at most 10 value pairs. Constraints N/A Range N/A Default Value N/A
without_any_tag	No	Boolean	Definition Resources without any tags are queried. If this parameter is set to true, all resources without any tags are queried. In this case, skip the tags field. If this parameter is set to false or not specified, it does not take effect, meaning that all resources are returned or resources are filtered by tags or matches. If this parameter is not specified, an empty value is returned. Constraints N/A Range N/A Default Value N/A
matches	No	Array of TagMatches objects	Definition Search field. key indicates the search field. Currently, only the key pair name can be searched. The value is resource_name. value indicates the fuzzy match value, which can contain at most 255 characters. If this parameter is not specified, an empty value is returned. Constraints N/A Range N/A Default Value N/A
sys_tags	No	Array of Tag objects	Definition Tag list, which is the value pairs of tag keys and values. There can be at most 10 value pairs. Constraints N/A Range N/A Default Value N/A

**Table 4** TagMatches
Parameter	Mandatory	Type	Description
key	No	String	Definition Field to be matched Constraints The value can only be a key pair name. Range N/A Default Value N/A
value	No	String	Definition Tag value Constraints N/A Range The value can contain at most 255 characters and must match the regular expression *^([\p{L}\p{Z}\p{N}_.:\/=+\-@])$. Default Value** N/A

**Table 5** Tag
Parameter	Mandatory	Type	Description
key	No	String	Definition Tag key Constraints N/A Range N/A Default Value N/A
values	No	Array of strings	Definition Tag value set. There can be at most 10 tag values. Tag values in a tag list must be unique. If the tag list is empty, any tag value is matched. When there are multiple values in the tag list and the key requirements are met, a value in the request is matched. Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
total_count	Integer	Definition Total number of records Range N/A

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "val1" ]
  } ]
}

Status code: 200

Request succeeded.

{
  "total_count" : 1000
}