Disables one or more rules in an account group.

The sample request in this topic shows you how to disable the cr-5772ba41209e007b**** rule in the ca-04b3fd170e340007**** account group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeactiveAggregateConfigRules

The operation that you want to perform. Set the value to DeactiveAggregateConfigRules.

ConfigRuleIds String Yes cr-5772ba41209e007b****

The ID of the rule. Separate multiple rule IDs with commas (,).

For more information about how to obtain the ID of a rule, see ListAggregateConfigRules.

AggregatorId String Yes ca-04b3fd170e340007****

The ID of the account group.

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

For information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String 6EC7AED1-172F-42AE-9C12-295BC2ADB751

The ID of the request.

OperateRuleResult Object

The results of the operations to disable the specified rules.

OperateRuleItemList Array of OperateRuleItem

The result of the operation to disable the rule.

ErrorCode String ConfigRuleNotExists

The error code returned.

  • If the rule is disabled, no error code is returned.
  • If the rule fails to be disabled, an error code is returned. For more information about error codes, visit the API Error Center.
Success Boolean false

Indicates whether the operation is successful. Valid values:

  • true: The operation is successful.
  • false: The operation fails.
ConfigRuleId String cr-5772ba41209e007b****

The ID of the rule.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeactiveAggregateConfigRules
&ConfigRuleIds=cr-5772ba41209e007b****
&AggregatorId=ca-04b3fd170e340007****
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DeactiveAggregateConfigRulesResponse>
    <RequestId>6EC7AED1-172F-42AE-9C12-295BC2ADB751</RequestId>
    <OperateRuleResult>
        <OperateRuleItemList>
            <ErrorCode>ConfigRuleNotExists</ErrorCode>
            <Success>false</Success>
            <ConfigRuleId>cr-5772ba41209e007b****</ConfigRuleId>
        </OperateRuleItemList>
    </OperateRuleResult>
</DeactiveAggregateConfigRulesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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. The error message returned because you are not authorized to perform the specified operation.
400 Invalid.ConfigRuleIds.SizeExceed The maximum number of ConfigRuleIds cannot exceed 20. The error message returned because the number of specified rule IDs exceeds 20.
400 ConfigRuleStatusNotActive The status of the config rule is not active. The error message returned because the specified rule is not in the Active state.
400 Invalid.AggregatorId.Value The specified AggregatorId is invalid. The error message returned because the specified account group ID does not exist or you are not authorized to use the account group.
403 AggregatorMemberNoPermission The aggregator member is not authorized to perform the operation. The error message returned because you are using a member account and you are not authorized to perform the specified operation.
404 AccountNotExisted Your account does not exist. The error message returned because your account does not exist.
503 ServiceUnavailable The request has failed due to a temporary failure of the server. The error message returned because the service is unavailable.

For a list of error codes, visit the API Error Center.