GetAggregateResourceCountsGroupByRegion API - Cloud Config - Alibaba Cloud - Cloud Config

Operation description

The following example queries resource statistics in the account group ca-a260626622af0005**** by region. The response shows that 10 resources exist in the cn-hangzhou region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:GetAggregateResourceCountsGroupByRegion

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceType	string	No	The resource type. To obtain the type of a resource, see ListAggregateDiscoveredResources.	ACS::ECS::Instance
AggregatorId	string	Yes	The ID of the account group. To obtain the ID of an account group, see ListAggregators.	ca-a260626622af0005****
FolderId	string	No	The ID of the folder in the resource directory. To obtain the folder ID, see View the basic information of a folder.	r-BU****
ResourceAccountId	integer	No	The ID of the Alibaba Cloud account to which the resources in the account group belong. Note You can use either the ResourceAccountId or ResourceOwnerId parameter. We recommend that you use the ResourceAccountId parameter.	100931896542****

For more information about common request parameters, see API Reference.

Response elements

Element	Type	Description	Example
	object	None.
RequestId	string	The request ID.	399BD94C-D20C-4D27-88D4-89E8D75C0595
DiscoveredResourceCountsSummary	array<object>	The ID of the region by which statistics are collected.
	object
ResourceCount	integer	The total number of resources in the region.	10
GroupName	string	The dimension by which statistics are collected. Note In most cases, the `Region` parameter is returned instead of the GroupName parameter.	cn-hangzhou
Region	string	The ID of the region by which statistics are collected.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "399BD94C-D20C-4D27-88D4-89E8D75C0595",
  "DiscoveredResourceCountsSummary": [
    {
      "ResourceCount": 10,
      "GroupName": "cn-hangzhou",
      "Region": "cn-hangzhou"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	You are not authorized to perform this operation.
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.