All Products
Search
Document Center

Cloud Config:GetAggregateResourceCountsGroupByRegion

Last Updated:Jun 17, 2024

Queries the statistics on the resources in an account group by region.

Operation description

This topic provides an example on how to query the statistics on the resources in an account group named ca-a260626622af0005**** by region. The returned result shows that a total of 10 resources exist in the cn-hangzhou region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
config:GetAggregateResourceCountsGroupByRegionRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringNo

The resource type.

For more information about how to obtain the type of a resource, see ListAggregateDiscoveredResources .

ACS::ECS::Instance
AggregatorIdstringYes

The ID of the account group.

For more information about how to obtain the ID of an account group, see ListAggregators .

ca-a260626622af0005****
FolderIdstringNo

The ID of the folder in the resource directory. For more information about how to obtain the ID of a folder, see View the basic information of a folder.

r-BU****
ResourceAccountIdlongNo

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 parameters

ParameterTypeDescriptionExample
object

None.

RequestIdstring

The request ID.

399BD94C-D20C-4D27-88D4-89E8D75C0595
DiscoveredResourceCountsSummaryobject []

The ID of the region by which statistics are collected.

ResourceCountlong

The total number of resources in the region.

10
GroupNamestring

The dimension by which statistics are collected.

Note In most cases, the Region parameter is returned instead of the GroupName parameter.
cn-hangzhou
Regionstring

The ID of the region by which statistics are collected.

cn-hangzhou

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-12The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 503
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceAccountId