Querying Resource Quantity

Function

This API is used to query resource quantity.

API Calling

For details, see Calling APIs.

URI

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

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
resource_type	Yes	String	Resource type. The value is cts-tracker.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
without_any_tag	No	Boolean	Whether to query only untagged resources. If this parameter is set to true, all resources without tags are queried. In this case, the tags field is ignored. 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.
tags	No	Array of TmsTags objects	Tag list. A maximum of 20 keys can be included. Each key has a maximum of 20 values.
matches	No	Array of Match objects	Field to be matched. This parameter specifies the key-value pair to be matched in the query. If value is left blank, exact matching will work. Otherwise, fuzzy matching will work.

**Table 3** TmsTags
Parameter	Mandatory	Type	Description
key	No	String	Tag key, which can contain a maximum of 128 Unicode characters. A tag key can contain letters, digits, spaces, and special characters (_.:=+-@) but cannot start or end with a space.
values	No	Array of strings	Value list.

**Table 4** Match
Parameter	Mandatory	Type	Description
key	No	String	Key to be matched. It can only be resource_name.
value	No	String	Value to be matched. Each value can contain up to 255 Unicode characters. It cannot contain underscores (_) or percent signs (%).

Response Parameters

Status code: 200

**Table 5** Response body parameter
Parameter	Type	Description
total_count	Integer	Total number of resources.

Example Request

https://{endpoint}/v3/{project_id}/{resource_type}/resource-instances/count

{
  "offset" : "100",
  "limit" : "100",
  "action" : "count",
  "without_any_tag" : true,
  "tags" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "tags_any" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "not_tags" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "not_tags_any" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "sys_tags" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ],
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ]
}

Example Response

Status code: 200

The request is successful.

{
  "total_count" : 1000
}

Status Codes

Status Code	Description
200	The request is successful.

Error Codes

For details, see Error Codes.

Parent topic: Tag Management

Previous topic: Querying Resources by Tag

Next topic: Querying Resource Tags

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

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

For any further questions, feel free to contact us through the chatbot.

Chatbot