All Products
Search
Document Center

Cloud Config:CreateAggregateConfigRule

Last Updated:Mar 01, 2024

Creates a rule for an account group.

Operation description

Limits

You can create up to 200 rules for each management account.

Usage notes

This topic provides an example on how to create a rule based on the required-tags managed rule in the ca-a4e5626622af0079**** account group. The returned result shows that the rule is created and its ID is cr-4e3d626622af0080****.

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:CreateAggregateConfigRuleWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleNamestringYes

The rule name.

DescriptionstringNo

The description of the rule.

InputParametersobjectNo

The input parameter of the rule.

{"tag1Key":"ECS","tag1Value":"test"}
ConfigRuleTriggerTypesstringYes

The trigger type of the rule. Valid values:

  • ConfigurationItemChangeNotification: The rule is triggered by configuration changes.
  • ScheduledNotification: The rule is periodically triggered.
ConfigurationItemChangeNotification
MaximumExecutionFrequencystringNo

The interval at which the rule is triggered. Valid values:

  • One_Hour: 1 hour.
  • Three_Hours: 3 hours.
  • Six_Hours: 6 hours.
  • Twelve_Hours: 12 hours.
  • TwentyFour_Hours (default): 24 hours.
Note This parameter is required if the ConfigRuleTriggerTypes parameter is set to ScheduledNotification.
One_Hour
ResourceTypesScopearrayYes

The type of the resource evaluated by the rule. Separate multiple resource types with commas (,).

stringYes

The type of the resource evaluated by the rule. Separate multiple resource types with commas (,).

ACS::ECS::Instance
RiskLevelintegerYes

The risk level of the resources that are not compliant with the rule. Valid values:

  • 1: high risk level
  • 2: medium risk level
  • 3: low risk level
1
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

1594295238-f9361358-5843-4294-8d30-b5183fac****
RegionIdsScopestringNo

The ID of the region to which the rule applies. Separate multiple region IDs with commas (,).

Note This parameter applies only to a managed rule.
cn-hangzhou
ExcludeResourceIdsScopestringNo

The ID of the resource to be excluded from the compliance evaluations performed by the rule. Separate multiple resource IDs with commas (,).

Note This parameter applies only to a managed rule.
lb-t4nbowvtbkss7t326****
AggregatorIdstringYes

The ID of the account group.

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

ca-a4e5626622af0079****
ResourceGroupIdsScopestringNo

The ID of the resource group to which the rule applies. Separate multiple resource group IDs with commas (,).

Note This parameter applies only to a managed rule.
rg-aekzc7r7rhx****
TagKeyScopestringNo

The tag key used to filter resources. The rule applies only to the resources with the specified tag key. Separate multiple parameter values with commas (,).

Note This parameter applies only to a managed rule. You must configure the TagKeyScope and TagValueScope parameters at the same time.
ECS
TagValueScopestringNo

The tag value used to filter resources. The rule applies only to the resources with the specified tag value.

Note This parameter applies only to a managed rule. You must configure the TagKeyScope and TagValueScope parameters at the same time.
test
SourceOwnerstringYes

The type of the rule. Valid values:

  • ALIYUN: managed rule
  • CUSTOM_FC: custom rule
ALIYUN
SourceIdentifierstringYes

The identifier of the rule.

  • If you set the SourceOwner parameter to ALIYUN, set this parameter to the name of the managed rule.
  • If you set the SourceOwner parameter to CUSTOM_FC, set this parameter to the Alibaba Cloud Resource Name (ARN) of the relevant function in Function Compute.

For more information about how to query the name of a managed rule, see Managed rules.

required-tags
TagKeyLogicScopestringNo

The logical relationship among the tag keys if you specify multiple tag keys for the TagKeyScope parameter. For example, if you set the TagKeyScope parameter to ECS,OSS and the TagKeyLogicScope parameter to AND, the rule applies to resources with both the ECS and OSS tag keys. Valid values:

  • AND
  • OR
AND
FolderIdsScopestringNo

The ID of the resource directory to which the rule applies, which means that the resources within member accounts in the resource directory are evaluated based on the rule.

Note
  • This parameter applies only to a rule of a global account group.

  • This parameter applies only to a managed rule.

fd-ZtHsRH****
ExcludeFolderIdsScopestringNo

The ID of the resource directory to which the rule does not apply, which means that the resources within member accounts in the resource directory are not evaluated based on the rule. Separate multiple resource directory IDs with commas (,).

Note
  • This parameter applies only to a rule of a global account group.

  • This parameter applies only to a managed rule.

fd-pWmkqZ****
ExcludeAccountIdsScopestringNo

The ID of the member account to which the rule does not apply, which means that the resources within the member account are not evaluated based on the rule. Separate multiple member account IDs with commas (,).

Note This parameter applies only to a managed rule.
120886317861****

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object

N/A.

ConfigRuleIdstring

The rule ID.

cr-4e3d626622af0080****
RequestIdstring

The request ID.

5895065A-196C-4254-8AD8-14EFC31EEF50

Examples

Sample success responses

JSONformat

{
  "ConfigRuleId": "cr-4e3d626622af0080****",
  "RequestId": "5895065A-196C-4254-8AD8-14EFC31EEF50"
}

Error codes

HTTP status codeError codeError messageDescription
400ExceedMaxRuleCountThe maximum number of rules is exceeded.The maximum number of rules is exceeded.
400ConfigRuleNotExistsThe ConfigRule does not exist.The rule does not exist.
400ConfigRuleExistsThe ConfigRule already exists.The config rule already exists.
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
403AggregatorMemberNoPermissionThe aggregator member is not authorized to perform the operation.The aggregator member is not authorized to perform the operation.
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-08-18The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 503