1. 接口描述
接口请求域名: config.tencentcloudapi.com 。
新增规则修正设置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateRemediation。 |
| Version | 是 | String | 公共参数,本接口取值:2022-08-02。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| RuleId | 是 | String | 规则 ID 示例值:cr-oPTxveTx0NbmcNmDNoQG |
| RemediationType | 是 | String | 修正类型取值: SCF:云函数(自定义修正)。 示例值:SCF |
| RemediationTemplateId | 是 | String | 修正模板 ID 示例值:qcs::scf:ap-guangzhou:100000005287:namespace/test/functions/aaa |
| InvokeType | 是 | String | 修正执行方式。 示例值:MANUAL_EXECUTION |
| SourceType | 否 | String | 执行修正的模板来源 示例值:CUSTOM |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RemediationId | String | 修正设置Id 示例值:crr-lKj43O4nbSD78XYlvGS9 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建修正设置
输入示例
POST / HTTP/1.1
Host: config.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateRemediation
<公共请求参数>
{
"RuleId": "cr-oPTxveTx0NbmcNmDNoQG",
"RemediationType": "SCF",
"RemediationTemplateId": "qcs::scf:ap-guangzhou:100000005287:namespace/test/functions/aaa",
"InvokeType": "MANUAL_EXECUTION",
"SourceType": "CUSTOM"
}
输出示例
{
"Response": {
"RemediationId": "crr-lKj43O4nbSD78XYlvGS9",
"RequestId": "4c9384a0-e80c-4af0-a84c-8682527c86a0"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| LimitExceeded.RemediationMaxNum | 创建修复设置超过上限。 |