Use DeactiveAggregateConfigRules to disable rules in an account group - Cloud Config - Alibaba Cloud - Cloud Config

Operation description

Before you begin

Ensure that the status of the rule is ACTIVE (Active).

Usage notes

This topic provides an example to show how to disable the rule cr-5772ba41209e007b**** in the account group ca-04b3fd170e340007****.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:DeactiveAggregateConfigRules

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleIds	string	No	The rule IDs. Separate multiple rule IDs with commas (,). For more information about how to obtain a rule ID, see ListAggregateConfigRules.	cr-5772ba41209e007b****
AggregatorId	string	Yes	The account group ID. For more information about how to obtain an account group ID, see ListAggregators.	ca-04b3fd170e340007****
CompliancePackId	string	No	The compliance package ID.	cp-fe416457e0d90022****

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

Response elements

Element	Type	Description	Example
	object	None.
RequestId	string	The request ID.	6EC7AED1-172F-42AE-9C12-295BC2ADB751
OperateRuleResult	object	The operation result of disabling the rule.
OperateRuleItemList	array<object>	The list of operations for disabling the rule.
	object	None.
ErrorCode	string	The error code. If the rule is disabled, this parameter is empty. If the rule fails to be disabled, this parameter indicates the error code. For more information about error codes, see Error Center.	ConfigRuleStatusNotActive
Success	boolean	Indicates whether the operation is successful. Valid values: true: The operation is successful. false: The operation fails.	false
ConfigRuleId	string	The rule ID.	cr-5772ba41209e007b****

Examples

Success response

JSON format

{
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
  "OperateRuleResult": {
    "OperateRuleItemList": [
      {
        "ErrorCode": "ConfigRuleNotExists",
        "Success": false,
        "ConfigRuleId": "cr-5772ba41209e007b****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform this operation.
400	Invalid.ConfigRuleIds.SizeExceed	The maximum number of ConfigRuleIds cannot exceed 20.	The maximum number of ConfigRuleIds cannot exceed 20.
400	ConfigRuleStatusNotActive	The status of the config rule is not active.	The status of the config rule is not active.
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.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.