1. 接口描述
接口请求域名： tse.tencentcloudapi.com 。
获取 WAF 防护状态
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWafProtection。 |
| Version | 是 | String | 公共参数，本接口取值：2020-12-07。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn 。 |
| GatewayId | 是 | String | 网关ID 示例值：gateway-962b7d7c |
| TypeList.N | 否 | Array of String | 防护资源类型列表，支持查询多个类型（Global、Service、Route、Object）。为空时，默认查询Global类型。 示例值：["Global","Object"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | DescribeWafProtectionResult | 保护状态 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取 WAF 防护状态
获取 WAF 防护状态
输入示例
POST / HTTP/1.1
Host: tse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWafProtection
<公共请求参数>
{
"GatewayId": "gateway-0f7c158e",
"Type": "Global"
}输出示例
{
"Response": {
"Result": {
"GlobalStatus": "Open"
},
"RequestId": "abc"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.FailedOperation | 操作失败。 |
| FailedOperation.InternalError | 操作失败，内部错误。 |
| FailedOperation.Role | 获取临时密钥失败 |
| FailedOperation.Vpc | 调用VPC服务失败 |
| InternalError | 内部错误。 |
| InternalError.QueryError | 查询内部错误。 |
| InternalError.UnknownError | 未知错误。 |
| InvalidParameterValue.BadRequestFormat | 请求格式不正确。 |
| InvalidParameterValue.InvalidParameterValue | 无效的参数值。 |
| InvalidParameterValue.OperationFailed | 无效请求参数导致操作失败。 |
| InvalidParameterValue.Region | 无效的Region。 |
| InvalidParameterValue.ResourceAlreadyExist | 资源已经存在。 |
| InvalidParameterValue.Specification | 网关规格参数内容错误 |
| InvalidParameterValue.Type | 网关类型参数内容错误 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound.InstanceNotFound | 实例不存在。 |
| ResourceNotFound.ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation.CamNoAuth | cam认证失败。 |
| UnauthorizedOperation.CamPassRoleNotExist | 子账号缺少passRole权限。 |
| UnauthorizedOperation.Uin | Uin未授权 |
| UnauthorizedOperation.UnauthorizedOperation | 未授权的操作。 |