Querying Resource Aggregators_Resource Aggregators_APIs_API Reference (Kuala Lumpur Region)

Function

This API is used to query resource aggregators.

Calling Method

For details, see Calling APIs.

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
aggregator_name	No	String	Specifies the name of a resource aggregator. Minimum: 1 Maximum: 64
limit	No	Integer	Specifies the maximum number of records to return. Minimum: 1 Maximum: 200 Default: 200
marker	No	String	Specifies a pagination parameter. Pass the marker value returned from the previous request to retrieve the current page of results. Minimum length: 4 characters Maximum length: 400 characters

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
configuration_aggregators	Array of ConfigurationAggregatorResp objects	Specifies resource aggregators.
page_info	PageInfo object	Specifies the pagination object.

**Table 5** ConfigurationAggregatorResp
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 6** AccountAggregationSource
Parameter	Type	Description
domain_ids	Array of strings	Specifies the account list. Minimum: 1 Maximum: 36 Array Length: 1 - 30

**Table 7** PageInfo
Parameter	Type	Description
current_count	Integer	Specifies the resource quantity on the current page. Minimum: 0 Maximum: 200
next_marker	String	Specifies the marker value of the next page. Minimum length: 4 characters Maximum length: 400 characters

Status code: 400

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

Status code: 403

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

Status code: 500

**Table 10** 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.

{
  "configuration_aggregators" : [ {
    "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"
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : "CAESIDdjYTM0NDc4MzBiZDQ5YzliNjMwYTk5NjgwZWFmOTBmGgQ-0aw3"
  }
}

Status Codes

Status Code	Description
200	Operation succeeded.
400	Invalid parameters.
403	Authentication failed or you do not have the operation permissions.
500	Server error.

Error Codes

See Error Codes.

Querying Resource Aggregators