All Products
Search
Document Center

Cloud Config:DeactiveConfigRules

Last Updated:Mar 01, 2024

Disables one or more rules.

Operation description

In this example, the cr-19a56457e0d90058**** rule is used.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
config:DeactiveConfigRulesWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdsstringYes

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

54FA74D9-45D4-4CA5-9BE1-97F6EA19AF5B
OperateRuleResultobject

The results of the operations to disable the specified rules.

OperateRuleItemListobject []

The result of the operation to disable the rule.

ErrorCodestring

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, visit the API Error Center.
ConfigRuleCanNotDelete
Successboolean

Indicates whether the operation is successful. Valid values:

  • true: The operation is successful.
  • false: The operation fails.
false
ConfigRuleIdstring

The ID of the rule.

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 codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
400Invalid.ConfigRuleIds.SizeExceedThe maximum number of ConfigRuleIds cannot exceed 20.The maximum number of ConfigRuleIds cannot exceed 20.
400ConfigRuleStatusNotActiveThe status of the config rule is not active.The status of the config rule is not active.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe 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.