Updating a Resource Aggregator_Resource Aggregators_APIs_API Reference (Kuala Lumpur Region)

Function

This API is used to update a resource aggregator.

Calling Method

For details, see Calling APIs.

URI

PUT /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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
aggregator_name	Yes	String	Specifies the name of a resource aggregator. Minimum: 1 Maximum: 64
aggregator_type	Yes	String	Specifies the resource aggregator type, which can be ACCOUNT or ORGANIZATION.
account_aggregation_sources	No	AccountAggregationSource object	Specifies the source account of the aggregated data.

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

Response Parameters

Status code: 200

**Table 5** 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 6** 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 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

Updating a resource aggregator

PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators/{aggregator_id}

{
  "aggregator_name" : "example_aggregator",
  "aggregator_type" : "ACCOUNT",
  "account_aggregation_sources" : {
    "domain_ids" : [ "3fd23817bd85480e8dc4f520075de348" ]
  }
}

Example Responses

Status code: 200

Operation succeeded.

{
  "aggregator_name" : "example_aggregator",
  "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f",
  "aggregator_urn" : "rms::e74e043fab784a45ad88f5ef6a4bcffc:aggregationAggregator:7ca3447830bd49c9b630a99680eaf90f",
  "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"
}

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.

Updating a Resource Aggregator