基于规则模板创建账号组规则,并设置触发方式、运行参数、资源范围和风险等级;创建后按触发配置评估账号组内资源;Modify 规则可设置允许的修正触发方式。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | CreateAccountGroupRule | 要执行的操作,取值:CreateAccountGroupRule。 |
Version | String | 是 | 2025-01-01 | API的版本,取值:2025-01-01。 |
AccountGroupId | String | 是 | ag-123456 | 账号组 ID |
RuleTemplateId | String | 是 | rt-123456 | 规则模板 ID |
RuleName | String | 是 | example-rule | 规则名称 |
Description | String | 是 | example description | 描述 |
Triggers | Array of Object | 是 | [{"TriggerType":"ConfigurationItemChange","MaximumExecutionFrequency":"OneHour"}] | 规则触发方式配置 |
InputParameters | String | 是 | {"allowedRegions":["cn-beijing"]} | 规则运行时参数,JSON 字符串 |
Scope | Object | 是 | {"ResourceTypes":{"Include":["cn-beijing"],"Exclude":["cn-shanghai"]},"ResourceIds":{"Include":["cn-beijing"],"Exclude":["cn-shanghai"]},"Regions":{"Include":["cn-beijing"],"Exclude":["cn-shanghai"]},"Projects":{"Include":["cn-beijing"],"Exclude":["cn-shanghai"]},"Tags":{"Include":[{"Key":{},"Value":{}}],"Exclude":[{"Key":{},"Value":{}}]}} | 资源评估范围 |
RiskLevel | String | 是 | Low | 风险等级,可选值:Low,Medium,High |
Effect | String | 否 | Audit | 规则执行效果,可选值:Audit,Modify;不传时默认 Audit |
RemediationTriggerTypes | Array of String | 否 | ["Manual","Auto"] | Modify 规则允许创建修正任务的触发方式,可选 Manual、Auto;不传时默认 Manual,Audit 规则不生效。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
RuleId | String | rule-123456 | 规则 ID |
POST /?Action=CreateAccountGroupRule&Version=2025-01-01 HTTP/1.1 Host: config.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20260629T093000Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=<Credential>/20260629/cn-beijing/config/request, SignedHeaders=host;x-content-sha256;x-date, Signature=<Signature> { "AccountGroupId": "ag-123456", "RuleTemplateId": "rt-123456", "RuleName": "example-rule", "Description": "example description", "Triggers": [ { "TriggerType": "ConfigurationItemChange", "MaximumExecutionFrequency": "OneHour" } ], "InputParameters": "{\"allowedRegions\":[\"cn-beijing\"]}", "Scope": { "ResourceTypes": { "Include": [ "Volcengine::Ecs::Instance" ] } }, "RiskLevel": "Low", "Effect": "Modify", "RemediationTriggerTypes": [ "Manual", "Auto" ] }
{ "ResponseMetadata": { "RequestId": "202606291730000000000000000000", "Action": "CreateAccountGroupRule", "Version": "2025-01-01", "Service": "config", "Region": "cn-beijing" }, "Result": { "RuleId": "rule-123456" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | QuotaExceeded.Rule | 该账号下的规则已超quota限额,请删除非必要规则或提工单提额 |
400 | InvalidParameter.RemediationTriggerTypes | 修正触发方式不合法,或与规则执行效果不匹配。 |