文档

CreateAggregateConfigRule - 创建账号组规则

更新时间:

为指定账号组创建规则。

接口说明

使用限制

每个企业管理账号最多可以创建 200 条规则。

使用说明

本文将提供一个示例,为账号组ca-a4e5626622af0079****创建一条托管规则“存在所有指定标签”。返回结果显示规则创建成功,规则 ID 为cr-4e3d626622af0080****

调试

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

授权信息

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

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

请求参数

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

规则名称。

存在所有指定标签
Descriptionstring

规则描述。

最多可以定义6组标签。如果资源同时具有指定的所有标签,则视为“合规”。
InputParametersobject

规则参数。

{"tag1Key":"ECS","tag1Value":"test"}
ConfigRuleTriggerTypesstring

规则触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。
  • ScheduledNotification:周期执行。
ConfigurationItemChangeNotification
MaximumExecutionFrequencystring

规则执行周期。取值:

  • One_Hour:1 小时。
  • Three_Hours:3 小时。
  • Six_Hours:6 小时。
  • Twelve_Hours:12 小时。
  • TwentyFour_Hours(默认值):24 小时。
说明 ConfigRuleTriggerTypes设置为ScheduledNotification时,需要设置该参数。
One_Hour
ResourceTypesScopearray

规则评估的资源类型。多个资源类型之间用半角逗号(,)分隔。

string

规则评估的资源类型。多个资源类型之间用半角逗号(,)分隔。

ACS::ECS::Instance
RiskLevelinteger

规则风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
1
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持 ASCII 字符,且不能超过 64 个字符。

1594295238-f9361358-5843-4294-8d30-b5183fac****
RegionIdsScopestring

规则仅对指定地域 ID 中的资源生效。多个地域 ID 之间用半角逗号(,)分隔。

说明 仅适用于托管规则。
cn-hangzhou
ExcludeResourceIdsScopestring

规则对指定资源 ID 无效,即不对该资源执行评估。多个资源 ID 之间用半角逗号(,)分隔。

说明 仅适用于托管规则。
lb-t4nbowvtbkss7t326****
AggregatorIdstring

账号组 ID。

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

ca-a4e5626622af0079****
ResourceGroupIdsScopestring

规则仅对指定资源组 ID 中的资源生效。多个资源组 ID 之间用半角逗号(,)分隔。

说明 仅适用于托管规则。
rg-aekzc7r7rhx****
TagKeyScopestring

规则仅对绑定指定标签的资源生效。多个标签之间用半角逗号(,)分隔。

说明 仅适用于托管规则,且TagKeyScopeTagValueScope必须同时设置。
ECS
TagValueScopestring

规则仅对绑定指定标签的资源生效。

说明 仅适用于托管规则,且TagKeyScopeTagValueScope必须同时设置。
test
SourceOwnerstring

规则类型。取值:

  • ALIYUN:托管规则。
  • CUSTOM_FC:自定义规则。
ALIYUN
SourceIdentifierstring

规则标识符。

  • 当 SourceOwner 为 ALIYUN 时,输入托管规则的标识符。

  • 当 SourceOwner 为 CUSTOM_FC 时,输入函数计算的函数 ARN。

关于如何查询托管规则标识符,请参见托管规则列表

required-tags
TagKeyLogicScopestring

参数TagKeyScope取多值时的逻辑关系,例如:当参数TagKeyScope取值为ECS,OSS时,如果该参数为AND,则表示规则仅对同时绑定标签ECSOSS的资源生效。取值:

  • AND:与。

  • OR:或。

AND
FolderIdsScopestring

规则仅对指定资源目录 ID 中成员账号内的资源生效。

说明
  • 该参数仅作用于全局账号组的规则。
  • 仅适用于托管规则。
  • fd-ZtHsRH****
    ExcludeFolderIdsScopestring

    规则对指定资源目录 ID 中成员账号内的资源无效,即不对该资源目录 ID 中成员账号内的资源执行评估。多个资源目录 ID 之间用半角逗号(,)分隔。

    说明
  • 该参数仅作用于全局账号组的规则。
  • 仅适用于托管规则。
  • fd-pWmkqZ****
    ExcludeAccountIdsScopestring

    规则对指定成员账号内的资源无效,即不对该账号内的资源执行评估。多个成员账号 ID 之间用半角逗号(,)分隔。

    说明 仅适用于托管规则。
    120886317861****

    返回参数

    名称类型描述示例值
    object

    ConfigRuleIdstring

    规则 ID。

    cr-4e3d626622af0080****
    RequestIdstring

    请求 ID。

    5895065A-196C-4254-8AD8-14EFC31EEF50

    示例

    正常返回示例

    JSON格式

    {
      "ConfigRuleId": "cr-4e3d626622af0080****",
      "RequestId": "5895065A-196C-4254-8AD8-14EFC31EEF50"
    }

    错误码

    HTTP status code错误码错误信息描述
    400ExceedMaxRuleCountThe maximum number of rules is exceeded.超过规则上限。
    400ConfigRuleNotExistsThe ConfigRule does not exist.此规则不存在。
    400ConfigRuleExistsThe ConfigRule already exists.规则名称重复。
    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-08-18OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
      删除错误码:503
    • 本页导读 (1)
    文档反馈