1. 接口描述
接口请求域名： config.tencentcloudapi.com 。
新建 规则
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AddConfigRule。 |
| Version | 是 | String | 公共参数，本接口取值：2022-08-02。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Identifier | 是 | String | 规则模板标识，预设规则模板为Identifier, 自定义规则为云函数arn（region:functionName） 示例值：1 |
| IdentifierType | 是 | String | 规则模板类型，SYSTEM, CUSTOMIZE 示例值：SYSTEM |
| RuleName | 是 | String | 规则名称 示例值：规则1 |
| ResourceType.N | 是 | Array of String | 规则支持的资源 示例值：[""] |
| TriggerType.N | 是 | Array of TriggerType | 触发类型，最多支持两种 示例值：1 |
| RiskLevel | 是 | Integer | 风险等级 1：高风险。 2：中风险。 3：低风险。 示例值：2 |
| InputParameter.N | 否 | Array of InputParameter | 入参 |
| Description | 否 | String | 规则描述。长度范围0~1024字符 示例值：RAM用户开启MFA，视为“合规”。 |
| RegionsScope.N | 否 | Array of String | 规则评估地域范围，规则仅对指定地域中的资源生效。 支持的地域范围config:ListResourceRegions返回的地域 |
| TagsScope.N | 否 | Array of Tag | 规则评估标签范围，规则仅对绑定指定标签的资源生效。 |
| ExcludeResourceIdsScope.N | 否 | Array of String | 规则对指定资源ID无效，即不对该资源执行评估。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加规则
添加规则
输入示例
POST / HTTP/1.1
Host: config.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddConfigRule
<公共请求参数>
{
"Identifier": "cam-user-group-bound",
"IdentifierType": "SYSTEM",
"RuleName": "CAM访问管理子用户必须关联用户组",
"ResourceType": [
"QCS::CAM::User"
],
"RiskLevel": 3,
"Description": "帐号访问管理中用户至少关联一个用户组，则符合规则。",
"TriggerType": [
{
"MessageType": "ScheduledNotification",
"MaximumExecutionFrequency": "TwentyFour_Hours"
}
],
"InputParameter": []
}输出示例
{
"Response": {
"RequestId": "da85d5e2-4432-4f02-9863-0ab07adeff33"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.RuleNameIsExist | 规则名称已存在。 |
| InvalidParameter | 参数错误。 |
