1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
查询业务和攻击概要趋势
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribePeakPoints。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-shanghai 。 |
| FromTime | 是 | Timestamp | 查询起始时间 示例值：2019-12-30 00:00:00 |
| ToTime | 是 | Timestamp | 查询终止时间 示例值：2019-12-30 23:59:59 |
| Domain | 否 | String | 查询的域名，如果查询所有域名数据，该参数不填写 示例值：abc.qcloudwaf.com |
| Edition | 否 | String | 只有两个值有效，sparta-waf，clb-waf，不传则不过滤 示例值：sparta-waf |
| InstanceID | 否 | String | WAF实例ID，不传则不过滤 示例值：waf_000q3t12p |
| MetricName | 否 | String | 十二个值可选： access-峰值qps趋势图 botAccess- bot峰值qps趋势图 down-下行峰值带宽趋势图 up-上行峰值带宽趋势图 attack-Web攻击总数趋势图 cc-CC攻击总数趋势图 bw-黑IP攻击总数趋势图 tamper-防篡改攻击总数趋势图 leak-防泄露攻击总数趋势图 acl-访问控制攻击总数趋势图 http_status-状态码各次数趋势图 wx_access-微信小程序峰值qps趋势图 示例值：access |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Points | Array of PeakPointsItem | 数据点 示例值：[{"Access":10}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询业务和攻击概要趋势
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePeakPoints
<公共请求参数>
{
"FromTime": "2021-07-21 00:00:00",
"ToTime": "2021-07-21 23:59:59"
}输出示例
{
"Response": {
"Points": [
{
"Time": 1626908400,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626908460,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626908520,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626908580,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626908640,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626908700,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626908760,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626908820,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626908880,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626908940,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
},
{
"Time": 1626909000,
"Access": 0,
"BotAccess": 0,
"Attack": 0,
"Cc": 0,
"Down": 0,
"Up": 0,
"StatusServerError": 1,
"StatusClientError": 1,
"StatusRedirect": 1,
"StatusOk": 1,
"UpstreamServerError": 1,
"UpstreamClientError": 1,
"UpstreamRedirect": 1
}
],
"RequestId": "ead32d5d-a9ac-496f-b8e3-d3a92f1fb1ce"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| FailedOperation.CLSInternalError | CLS内部错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidCertificate | 证书内容非法。 |
| InvalidParameter.QueryCertBySSLIDFailed | 根据ID查询证书失败。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
