All Products
Search
Document Center

Cloud Config:DeleteAggregateConfigRules

Last Updated:Mar 01, 2024

Deletes one or more rules from an account group.

Operation description

Background information

You can delete a rule in the Cloud Config console. After you delete the rule, the configurations of the rule are deleted.

Usage notes

This topic provides an example on how to delete the cr-4e3d626622af0080**** rule from the ca-a4e5626622af0079**** account group.

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:DeleteAggregateConfigRulesWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ConfigRuleIdsstringYes

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

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

cr-4e3d626622af0080****
AggregatorIdstringYes

The ID of the account group.

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

ca-a4e5626622af0079****

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

Response parameters

ParameterTypeDescriptionExample
object

N/A.

RequestIdstring

The request ID.

6EC7AED1-172F-42AE-9C12-295BC2ADB751
OperateRuleResultobject

The results of the delete operations.

OperateRuleItemListobject []

The details of the result.

ErrorCodestring

The error code returned.

  • If the rule is deleted, no error code is returned.
  • If the rule fails to be deleted, an error code is returned. For more information about error codes, see Error codes.
ConfigRuleCanNotDelete
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
false
ConfigRuleIdstring

The rule ID.

cr-4e3d626622af0080****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
400ConfigRuleCanNotDeleteThe config rule cannot be deleted.The config rule cannot be deleted.
400Invalid.ConfigRuleIds.SizeExceedThe maximum number of ConfigRuleIds cannot exceed 20.The maximum number of ConfigRuleIds cannot exceed 20.
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.The specified aggregator ID does not exist or you are not authorized to use the aggregator.
403AggregatorMemberNoPermissionThe aggregator member is not authorized to perform the operation.The aggregator member is not authorized to perform the operation.
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.