调用PutConfigRule接口新建或修改规则。

调试

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

请求参数

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

要执行的操作,取值:PutConfigRule。

ConfigRuleName String rds-cpu-min-count-limit-rd

规则名称。

RiskLevel Integer 1

风险等级。取值:

  • 1:Critical
  • 2:Warning
  • 3:Info
ScopeComplianceResourceTypes String ["ACS::RDS::DBInstance"]

该规则待评估的资源类型列表。

SourceDetailMessageType String ConfigurationItemChangeNotification

规则的触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更
  • ScheduledNotification:周期
SourceIdentifier String rds-cpu-min-count-limit

规则名称。

  • 如果规则使用了托管规则,则该参数为托管规则名称。
  • 如果规则使用了自定义函数,则该参数为函数ARN。
SourceOwner String ALIYUN

规则引用的规则函数的归属方。取值:

  • CUSTOM_FC:用户自定义函数
  • ALIYUN:托管规则
ConfigRuleId String cr-2a914fcf617e00c9****

规则ID。

Description String 您账号下的RDS实例CPU数量大于等于您设置的阈值,视为“合规”。

规则的描述信息。

InputParameters String {"cpuCount": "2"}

规则入参。

SourceMaximumExecutionFrequency String Twelve_Hours

规则执行周期。取值:

  • One_Hour:1小时
  • Three_Hours:3小时
  • Six_Hours:6小时
  • Twelve_Hours:12小时
  • TwentyFour_Hours:24小时
ScopeComplianceResourceId String vpc-6weoy5flv41pj4wvr****

待评估资源ID。

  • 如果为空,则该规则评估ScopeComplianceResourceTypes指定的所有资源类型。
  • 如果不为空,则该规则评估指定的资源。
ClientToken String TF-dfc5********************3dc

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

MultiAccount Boolean false

企业管理账号是否为成员账号新建或修改规则。取值:

  • true:是。企业管理账号为资源目录中的所有成员账号新建或修改规则。
  • false(默认值):否。企业管理账号为本账号新建或修改规则。
说明 当您使用个人版配置审计时,请忽略该参数。
MemberId Long 1234567

待新建或修改规则归属的成员账号ID。默认为空。当MultiAccount设置为true时,该参数有效。

  • 当MemberId为空时,为企业管理账号和所有成员账号新建或修改规则。
  • 当MemberId不为空时,为指定成员账号新建或修改规则。
说明 当您使用个人版配置审计时,请忽略该参数。

返回数据

名称 类型 示例值 描述
ConfigRuleId String cr-76ac4fcfb57e00c9****

规则ID。

RequestId String A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=PutConfigRule
&ConfigRuleName=rds-cpu-min-count-limit-rd
&RiskLevel=1
&ScopeComplianceResourceTypes=["ACS::RDS::DBInstance"]
&SourceDetailMessageType=ConfigurationItemChangeNotification
&SourceIdentifier=rds-cpu-min-count-limit
&SourceOwner=ALIYUN
&<公共请求参数>

正常返回示例

XML 格式

<PutConfigRuleResponse>
	  <ConfigRuleId>cr-76ac4fcfb57e00c9****</ConfigRuleId>
	  <RequestId>A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7</RequestId>
</PutConfigRuleResponse>

JSON 格式

{
    "ConfigRuleId": "cr-76ac4fcfb57e00c9****",
    "RequestId": "A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7"
}

错误码

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

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