1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
获取Api请求详情信息
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeApiDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Domain | 是 | String | 域名 示例值：qcloudwaf.com |
| ApiName | 是 | String | Api名称 示例值：/ddp |
| Method | 是 | String | 请求方法 示例值：GET |
| IsSensitive | 否 | Integer | 是否仅查询敏感的，1表示查询，0表示不查询 示例值：0 |
| IsPan | 否 | Integer | 是否仅查询泛化的，1表示查询，0表示不查询 示例值：1Log |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Log | String | 请求样例，json字符串格式 示例值：{"meyhod":"GET"} |
| ParameterList | Array of ApiParameterType | 请求参数样例列表 示例值：{"meyhod":"GET"} |
| Scene | String | 当前场景标签 示例值："login" |
| SensitiveFields | Array of String | 敏感字段 示例值：[""] |
| IsActive | Boolean | 7天内是否活跃 示例值：true |
| IpCount | Integer | 访问ip数 示例值：100 |
| RegionCount | Integer | 访问地域数量 示例值：20 |
| EventCount | Integer | 关联事件数 示例值：10 |
| SensitiveCount | Integer | 涉敏数据条数 示例值：10 |
| Level | Integer | 风险等级 示例值：100 |
| RspLog | String | 响应体 示例值：100 |
| MaxQPS | Integer | 昨日访问峰值QPS 示例值：200 |
| ApiDetailSampleHistory | Array of ApiDetailSampleHistory | 历史样例 示例值：[""] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取Api请求详情信息
获取Api请求详情信息
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiDetail
<公共请求参数>
{
"Domain": "hzh.qcloud.com",
"Method": "POST",
"ApiName": "/test"
}输出示例
{
"Response": {
"RequestId": "6088f081-3e69-421e-9bbe-b91510af0414",
"Log": "{\"other\":{}}",
"ParameterList": [],
"Scene": "waf",
"SensitiveFields": [],
"IsActive": false,
"IpCount": 0,
"RegionCount": 0,
"EventCount": 0,
"SensitiveCount": 0,
"RspLog": "{\"other\":{}}",
"Level": 0
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| UnsupportedOperation | 操作不支持。 |
