首页 配置审计 开发参考 API参考 API参考(2020-09-07) API目录 规则 多账号 DeactiveAggregateConfigRules - 停用账号组规则

DeactiveAggregateConfigRules - 停用账号组规则

更新时间: 2024-12-18 19:55:25

停用指定账号组内的规则。停用规则后,不再对资源进行评估,仍显示停用前的合规评估结果。

接口说明

前提条件

请您确保规则的运行状态为ACTIVE(应用中)。

使用说明

本文将提供一个示例,停用账号组ca-04b3fd170e340007****内的规则cr-5772ba41209e007b****

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
config:DeactiveAggregateConfigRulesupdate
*全部资源
*

请求参数

名称类型必填描述示例值
ConfigRuleIdsstring

规则 ID。多个规则 ID 之间用半角逗号(,)分隔。

关于如何获取规则 ID,请参见 ListAggregateConfigRules

cr-5772ba41209e007b****
AggregatorIdstring

账号组 ID。

关于如何获取账号组 ID,请参见 ListAggregators

ca-04b3fd170e340007****
CompliancePackIdstring

合规包 ID。

cp-fe416457e0d90022****

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求 ID。

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

停用规则的操作结果。

OperateRuleItemListarray<object>

停用规则的操作列表。

OperateRuleItemobject

无。

ErrorCodestring

错误码。

  • 当您停用规则成功时,该参数为空。

  • 当您停用规则失败时,该参数显示错误码。错误码详情,请参见错误中心

ConfigRuleStatusNotActive
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

false
ConfigRuleIdstring

规则 ID。

cr-5772ba41209e007b****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
400Invalid.ConfigRuleIds.SizeExceedThe maximum number of ConfigRuleIds cannot exceed 20.输入的规则ID不能超过20个。
400ConfigRuleStatusNotActiveThe status of the config rule is not active.当前规则不是启用状态。
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.账号组ID不存在或无权限使用该账号组。
403AggregatorMemberNoPermissionThe aggregator member is not authorized to perform the operation.账号组内的成员账号无权限执行此操作。
404AccountNotExistedYour account does not exist.-
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-13OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
上一篇: ActiveAggregateConfigRules - 启用账号组规则 下一篇: IgnoreAggregateEvaluationResults - 忽略账号组规则评估结果