接口请求域名: config.intl.tencentcloudapi.com 。
新建 规则
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:AddConfigRule。 |
| Version | 是 | String | 公共参数,本接口取值:2022-08-02。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Identifier | 是 | String | 规则模板标识,预设规则模板为Identifier, 自定义规则为云函数arn(region:functionName) |
| IdentifierType | 是 | String | 规则模板类型,SYSTEM, CUSTOMIZE |
| RuleName | 是 | String | 规则名称 |
| ResourceType.N | 是 | Array of String | 规则支持的资源 |
| TriggerType.N | 是 | Array of TriggerType | 触发类型,最多支持两种 |
| RiskLevel | 是 | Integer | 风险等级 |
| InputParameter.N | 否 | Array of InputParameter | 入参 |
| Description | 否 | String | 规则描述。长度范围0~1024字符 |
| RegionsScope.N | 否 | Array of String | 规则评估地域范围,规则仅对指定地域中的资源生效。 |
| TagsScope.N | 否 | Array of Tag | 规则评估标签范围,规则仅对绑定指定标签的资源生效。 |
| ExcludeResourceIdsScope.N | 否 | Array of String | 规则对指定资源ID无效,即不对该资源执行评估。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleId | String | 规则ID |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
添加规则
POST / HTTP/1.1
Host: config.intl.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",
"RuleId": "cr-3xhsd76j603v0a8ma0i73"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.RuleNameIsExist | 规则名称已存在。 |
| InvalidParameter | 参数错误。 |
文档反馈