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
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
config:CreateAggregateConfigRule | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ConfigRuleName | string | Yes | The rule name. | |
Description | string | No | The description of the rule. | |
InputParameters | object | No | The input parameter of the rule. | {"tag1Key":"ECS","tag1Value":"test"} |
ConfigRuleTriggerTypes | string | Yes | The trigger type of the rule. Valid values:
| ConfigurationItemChangeNotification |
MaximumExecutionFrequency | string | No | The interval at which the rule is triggered. Valid values:
Note
This parameter is required if the ConfigRuleTriggerTypes parameter is set to ScheduledNotification .
| One_Hour |
ResourceTypesScope | array | Yes | The type of the resource evaluated by the rule. Separate multiple resource types with commas (,). | |
string | Yes | The type of the resource evaluated by the rule. Separate multiple resource types with commas (,). | ACS::ECS::Instance | |
RiskLevel | integer | Yes | The risk level of the resources that are not compliant with the rule. Valid values:
| 1 |
ClientToken | string | No | 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 | 1594295238-f9361358-5843-4294-8d30-b5183fac**** |
RegionIdsScope | string | No | 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 |
ExcludeResourceIdsScope | string | No | 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**** |
AggregatorId | string | Yes | The ID of the account group. For more information about how to obtain the ID of the account group, see ListAggregators . | ca-a4e5626622af0079**** |
ResourceGroupIdsScope | string | No | 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**** |
TagKeyScope | string | No | 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 |
TagValueScope | string | No | 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 |
SourceOwner | string | Yes | The type of the rule. Valid values:
| ALIYUN |
SourceIdentifier | string | Yes | The identifier of the rule.
For more information about how to query the name of a managed rule, see Managed rules. | required-tags |
TagKeyLogicScope | string | No | The logical relationship among the tag keys if you specify multiple tag keys for the
| AND |
FolderIdsScope | string | No | 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
| fd-ZtHsRH**** |
ExcludeFolderIdsScope | string | No | 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
| fd-pWmkqZ**** |
ExcludeAccountIdsScope | string | No | 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
Examples
Sample success responses
JSON
format
{
"ConfigRuleId": "cr-4e3d626622af0080****",
"RequestId": "5895065A-196C-4254-8AD8-14EFC31EEF50"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | ExceedMaxRuleCount | The maximum number of rules is exceeded. | The maximum number of rules is exceeded. |
400 | ConfigRuleNotExists | The ConfigRule does not exist. | The rule does not exist. |
400 | ConfigRuleExists | The ConfigRule already exists. | The config rule already exists. |
400 | Invalid.AggregatorId.Value | The specified AggregatorId is invalid. | The specified aggregator ID does not exist or you are not authorized to use the aggregator. |
403 | AggregatorMemberNoPermission | The aggregator member is not authorized to perform the operation. | The aggregator member is not authorized to perform the operation. |
404 | AccountNotExisted | Your account does not exist. | The specified account does not exist. |
503 | ServiceUnavailable | The 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 time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-08-18 | The Error code has changed | see changesets | ||||||||||
|