Help Center> Config> API Reference> APIs> Resource Aggregators> Querying the Number of Resources of a Resource Aggregator Account

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

Online Debugging

CLI Examples

View PDF

Querying the Number of Resources of a Resource Aggregator Account

Function

This API is used to query the number of resources of a resource aggregator account. The number can be counted by filter and GroupByKey.

Calling Method

For details, see Calling APIs.

URI

POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/aggregate-discovered-resource-counts

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies tags. Maximum: 36

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
aggregator_id	Yes	String	Specifies the resource aggregator ID. Minimum: 1 Maximum: 256
filter	No	ResourceCountsFilters object	Specifies the filter for counting resources.
group_by_key	Yes	String	Specifies the key used to group resource counts. Its value can be RESOURCE_TYPE or ACCOUNT_ID. Minimum: 1 Maximum: 16

**Table 4** ResourceCountsFilters
Parameter	Mandatory	Type	Description
account_id	No	String	Specifies the account ID. Minimum: 1 Maximum: 36
resource_type	No	String	Specifies the resource type. Minimum: 1 Maximum: 32
region_id	No	String	Specifies the region ID. Minimum: 1 Maximum: 32

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
group_by_key	String	Specifies the key for grouping resource counts.
grouped_resource_counts	Array of GroupedResourceCount objects	Specifies the list of group resources.
total_discovered_resources	Integer	Specifies the total number of resources in a filtered resource aggregator account.

**Table 6** GroupedResourceCount
Parameter	Type	Description
group_name	String	Specifies the group name.
resource_count	Integer	Specifies the number of resources.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

Querying the number of resources of a resource aggregator account

POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/aggregate-discovered-resource-counts

{
  "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f",
  "group_by_key" : "DOMAIN"
}

Example Responses

Status code: 200

Operation succeeded.

{
  "group_by_key" : "DOMAIN",
  "grouped_resource_counts" : [ {
    "group_name" : "3fd23817bd85480e8dc4f520075de348",
    "resource_count" : 23
  } ],
  "total_discovered_resources" : 23
}