Help Center> Config> API Reference> APIs> Resource Aggregators> Querying a Specific Resource Aggregator

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

Online Debugging

CLI Examples

View PDF

Querying a Specific Resource Aggregator

Function

This API is used to query a specific resource aggregator.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/domains/{domain_id}/aggregators/{aggregator_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies tags. Maximum: 36
aggregator_id	Yes	String	Specifies the resource aggregator ID. Maximum: 32

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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
aggregator_name	String	Specifies the name of a resource aggregator.
aggregator_id	String	Specifies the resource aggregator ID.
aggregator_urn	String	Specifies the resource aggregator identifier.
aggregator_type	String	Specifies the resource aggregator type.
account_aggregation_sources	AccountAggregationSource object	Specifies the source account of the aggregated data.
updated_at	String	Specifies the time when the resource aggregator was updated.
created_at	String	Specifies the time when the resource aggregator was created.

**Table 4** AccountAggregationSource
Parameter	Type	Description
domain_ids	Array of strings	Specifies the account list. Minimum: 1 Maximum: 36 Array Length: 1 - 30

Status code: 400

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

Status code: 403

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

Status code: 500

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

Example Requests

None

Example Responses

Status code: 200

Operation succeeded.

{
  "aggregator_name" : "example_aggregator",
  "aggregator_id" : "2f0cc4991bac4940ae20a3630818589e",
  "aggregator_urn" : "rms::e74e043fab784a45ad88f5ef6a4bcffc:aggregationAggregator:2f0cc4991bac4940ae20a3630818589e",
  "aggregator_type" : "ACCOUNT",
  "account_aggregation_sources" : {
    "domain_ids" : [ "3fd23817bd85480e8dc4f520075de348" ]
  },
  "updated_at" : "2020-01-18T02:49:12.465Z",
  "created_at" : "2020-01-18T02:49:12.465Z"
}