StopConfigRules - Cloud Config - Alibaba Cloud Documentation Center

Disables multiple rules at a time so that the rules enter the INACTIVE state.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:StopConfigRules	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ConfigRuleIds	string	Yes	The rule IDs. Separate multiple rule IDs with commas (,). You can specify a maximum of 20 rule IDs at a time.	cr-2da35180a8d1008e**,cr-2da35180a8d1008e**

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	49C1A88F-D163-46DF-84A6-F300229F37AE
OperateRuleResult	object	The result information about the operation.
OperateRuleItemList	array<object>	The result information about the operation.
OperateRuleItem	object
ConfigRuleId	string	The rule ID.	cr-2da35180a8d1008e****
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.	ConfigRuleStatusNotActive
Success	boolean	Indicates whether the rule is disabled. Valid values: true false	false

Examples

Sample success responses

JSONformat

{
  "RequestId": "49C1A88F-D163-46DF-84A6-F300229F37AE",
  "OperateRuleResult": {
    "OperateRuleItemList": [
      {
        "ConfigRuleId": "cr-2da35180a8d1008e****",
        "ErrorCode": "ConfigRuleStatusNotActive",
        "Success": false
      }
    ]
  }
}

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