DeactiveConfigRules - Cloud Config - Alibaba Cloud Documentation Center

Disables a rule. After a rule is disabled, the resource in the rule is no longer evaluated. The compliance evaluation results before the rule is disabled are still displayed.

Operation description

Prerequisites

The status of the rule is ACTIVE.

Description

This topic provides an example on how to disable the cr-19a56457e0d90058**** rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleIds	string	Yes	The ID of the rule. Separate multiple rule IDs with commas (,). For more information about how to obtain the ID of a rule, see ListConfigRules .	cr-19a56457e0d90058****

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	54FA74D9-45D4-4CA5-9BE1-97F6EA19AF5B
OperateRuleResult	object	The results of the operations that are performed to disable the specified rules.
OperateRuleItemList	array<object>	The operations that are performed to disable the rule.
	object
ErrorCode	string	The error code. 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, see Error codes.	ConfigRuleCanNotDelete
Success	boolean	Indicates whether the request was successful. Valid values: true false	false
ConfigRuleId	string	The rule ID.	cr-19a56457e0d90058****

Examples

Sample success responses

JSONformat

{
  "RequestId": "54FA74D9-45D4-4CA5-9BE1-97F6EA19AF5B",
  "OperateRuleResult": {
    "OperateRuleItemList": [
      {
        "ErrorCode": "ConfigRuleCanNotDelete",
        "Success": false,
        "ConfigRuleId": "cr-19a56457e0d90058****"
      }
    ]
  }
}

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.
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.