1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
修改大模型防护的模块开关状态,支持总开关及各子模块独立开关的开启/关闭操作。开启前需确保实例已购买大模型防护能力,未购买时开启操作会返回 AuthFailure.ErrCodeNoPurchased 错误。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyLLMStatus。 |
| Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Status | 是 | Boolean | 开关状态。true:开启,false:关闭。 示例值:true |
| Domain | 是 | String | 需要操作的域名或者serviceid 示例值:example.com |
| SwitchType | 是 | Integer | 开关类型,用于指定要操作的防护模块开关。取值如下: 示例值:1 |
| InstanceId | 否 | String | WAF 实例 ID,表示当前操作所属的 WAF 实例。可通过 DescribeInstances 接口获取。 示例值:waf_2kxtlbky01b3wceb |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Res | String | 操作结果,成功时返回 "Success"。 示例值:Success |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 关闭内容合规检测开关
关闭指定域名的内容合规检测(SwitchType=6)
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLLMStatus
<公共请求参数>
{
"Status": false,
"Domain": "example.com",
"SwitchType": 6,
"InstanceId": "waf_2kxtlbky01b3wceb"
}
输出示例
{
"Response": {
"RequestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"Res": "Success"
}
}
示例2 开启大模型防护总开关
开启指定域名的大模型防护总开关
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLLMStatus
<公共请求参数>
{
"Status": true,
"Domain": "example.com",
"SwitchType": 1,
"InstanceId": "waf_2kxtlbky01b3wceb"
}
输出示例
{
"Response": {
"RequestId": "086bade4-6f71-4b37-949d-ed472feb3d1e",
"Res": "Success"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.ErrCodeNoPurchased | 当前实例未购买api安全套餐 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| UnsupportedOperation.InvalidRequest | InvalidRequest |