Creating a Resource Aggregator
Function
This API is used to create a resource aggregator.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
rms:aggregators:create
Write
-
-
-
- organizations:organizations:get
- organizations:accounts:list
- organizations:delegatedAdministrators:list
- organizations:trustedServices:enable
- organizations:trustedServices:list
URI
PUT /v1/resource-manager/domains/{domain_id}/aggregators
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
domain_id |
Yes |
String |
Specifies the account ID. Maximum: 36 |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Security-Token |
No |
String |
Specifies a temporary security credential. This parameter is mandatory when you make an API call using a temporary security credential. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
aggregator_name |
Yes |
String |
Resource aggregator name. Minimum: 1 Maximum: 256 |
|
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. |
|
tags |
No |
Array of ResourceTag objects |
Tags. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
domain_ids |
No |
Array of strings |
Specifies the account list. Minimum: 1 Maximum: 36 Array Length: 1 - 30 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
key |
Yes |
String |
Tag key. A tag key can contain up to 128 Unicode characters and must comply with the character set specifications in section 3.1. Minimum: 1 Maximum: 128 |
|
value |
Yes |
String |
Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2. Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 200
|
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. |
|
tags |
Array of ResourceTag objects |
Tags. |
|
Parameter |
Type |
Description |
|---|---|---|
|
domain_ids |
Array of strings |
Specifies the account list. Minimum: 1 Maximum: 36 Array Length: 1 - 30 |
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
String |
Tag key. A tag key can contain up to 128 Unicode characters and must comply with the character set specifications in section 3.1. Minimum: 1 Maximum: 128 |
|
value |
String |
Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2. Minimum: 0 Maximum: 255 |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Specifies the error code. |
|
error_msg |
String |
Specifies the error message. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Specifies the error code. |
|
error_msg |
String |
Specifies the error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Specifies the error code. |
|
error_msg |
String |
Specifies the error message. |
Example Requests
Creating a resource aggregator
PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators
{
"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"
}
SDK Sample Code
The SDK sample code is as follows.
Creating a resource aggregator
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.config.v1.region.ConfigRegion; import com.huaweicloud.sdk.config.v1.*; import com.huaweicloud.sdk.config.v1.model.*; import java.util.List; import java.util.ArrayList; public class CreateConfigurationAggregatorSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); ConfigClient client = ConfigClient.newBuilder() .withCredential(auth) .withRegion(ConfigRegion.valueOf("<YOUR REGION>")) .build(); CreateConfigurationAggregatorRequest request = new CreateConfigurationAggregatorRequest(); ConfigurationAggregatorRequest body = new ConfigurationAggregatorRequest(); List<String> listAccountAggregationSourcesDomainIds = new ArrayList<>(); listAccountAggregationSourcesDomainIds.add("3fd23817bd85480e8dc4f520075de348"); AccountAggregationSource accountAggregationSourcesbody = new AccountAggregationSource(); accountAggregationSourcesbody.withDomainIds(listAccountAggregationSourcesDomainIds); body.withAccountAggregationSources(accountAggregationSourcesbody); body.withAggregatorType("ACCOUNT"); body.withAggregatorName("example_aggregator"); request.withBody(body); try { CreateConfigurationAggregatorResponse response = client.createConfigurationAggregator(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Creating a resource aggregator
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkconfig.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateConfigurationAggregatorRequest() listDomainIdsAccountAggregationSources = [ "3fd23817bd85480e8dc4f520075de348" ] accountAggregationSourcesbody = AccountAggregationSource( domain_ids=listDomainIdsAccountAggregationSources ) request.body = ConfigurationAggregatorRequest( account_aggregation_sources=accountAggregationSourcesbody, aggregator_type="ACCOUNT", aggregator_name="example_aggregator" ) response = client.create_configuration_aggregator(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creating a resource aggregator
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := config.NewConfigClient( config.ConfigClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateConfigurationAggregatorRequest{} var listDomainIdsAccountAggregationSources = []string{ "3fd23817bd85480e8dc4f520075de348", } accountAggregationSourcesbody := &model.AccountAggregationSource{ DomainIds: &listDomainIdsAccountAggregationSources, } request.Body = &model.ConfigurationAggregatorRequest{ AccountAggregationSources: accountAggregationSourcesbody, AggregatorType: "ACCOUNT", AggregatorName: "example_aggregator", } response, err := client.CreateConfigurationAggregator(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot