调用CreateConfigRule接口创建规则。

使用限制

每个普通账号最多可以创建200条规则。

使用说明

本文将提供一个示例，创建一条托管规则“存在所有指定标签”。返回结果显示规则创建成功，规则ID为cr-5772ba41209e007b****。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateConfigRule

要执行的操作，取值：CreateConfigRule。

ConfigRuleName String 是 存在所有指定标签

规则名称。
Description String 否 最多可以定义6组标签。如果资源同时具有指定的所有标签，则视为“合规”。

规则描述。
InputParameters Map 否 {"tag1Key":"ECS","tag1Value":"test"}

规则参数。
ConfigRuleTriggerTypes String 是 ConfigurationItemChangeNotification

规则触发机制。取值：

  • ConfigurationItemChangeNotification：配置变更。
  • ScheduledNotification：周期执行。
说明 当规则包括两种触发机制时，用半角逗号（,）分隔。
MaximumExecutionFrequency String 否 One_Hour

规则执行周期。取值：

  • One_Hour：1小时。
  • Three_Hours：3小时。
  • Six_Hours：6小时。
  • Twelve_Hours：12小时。
  • TwentyFour_Hours（默认值）：24小时。
说明 当ConfigRuleTriggerTypes设置为ScheduledNotification时，需要设置该参数。
ResourceTypesScope Array of String 是 ACS::ECS::Instance

规则评估的资源类型。多个资源类型之间用半角逗号（,）分隔。
RiskLevel Integer 是 1

规则风险等级。取值：

  • 1：高风险。
  • 2：中风险。
  • 3：低风险。
ClientToken String 否 1594295238-f9361358-5843-4294-8d30-b5183fac****

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

RegionIdsScope String 否 cn-hangzhou

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

说明 仅适用于托管规则。
ExcludeResourceIdsScope String 否 lb-t4nbowvtbkss7t326****

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

说明 仅适用于托管规则。
ResourceGroupIdsScope String 否 rg-aekzc7r7rhx****

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

说明 仅适用于托管规则。
TagKeyScope String 否 ECS

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

说明 仅适用于托管规则，且TagKeyScope和TagValueScope必须同时设置。
TagValueScope String 否 test

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

说明 仅适用于托管规则，且TagKeyScope和TagValueScope必须同时设置。
SourceOwner String 是 ALIYUN

创建的规则类型。取值：

  • ALIYUN：托管规则。
  • CUSTOM_FC：自定义规则。
SourceIdentifier String 是 required-tags

规则标识符。

  • 当SourceOwner为ALIYUN时，输入托管规则的标识符。
  • 当SourceOwner为CUSTOM_FC时，输入函数计算的函数ARN。

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

TagKeyLogicScope String 否 AND

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

  • AND：与。
  • OR：或。

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

返回数据

名称 类型 示例值 描述
ConfigRuleId String cr-5772ba41209e007b****

规则ID。
RequestId String 6EC7AED1-172F-42AE-9C12-295BC2ADB751

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateConfigRule
&ConfigRuleName=存在所有指定标签
&ConfigRuleTriggerTypes=ConfigurationItemChangeNotification
&ResourceTypesScope=["ACS::ECS::Instance"]
&RiskLevel=1
&SourceOwner=ALIYUN
&SourceIdentifier=required-tags
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateConfigRuleResponse>
    <ConfigRuleId>cr-5772ba41209e007b****</ConfigRuleId>
    <RequestId>6EC7AED1-172F-42AE-9C12-295BC2ADB751</RequestId>
</CreateConfigRuleResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ConfigRuleId" : "cr-5772ba41209e007b****",
  "RequestId" : "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}

错误码

HttpCode 错误码 错误信息 描述
400 ExceedMaxRuleCount The maximum number of rules is exceeded. 超过规则上限。
400 ConfigRuleNotExists The ConfigRule does not exist. 此规则不存在。
400 ConfigRuleExists The ConfigRule already exists. 规则名称重复。
404 AccountNotExisted Your account does not exist. 您的账号不存在。
503 ServiceUnavailable The request has failed due to a temporary failure of the server. 服务不可用。

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