获取业务和攻击概览峰值
最近更新时间: 2024-09-03 18:49:48
1. 接口描述
接口请求域名： ngwaf.api3.cloud.sunhongs.com。
获取业务和攻击概览峰值
默认接口请求频率限制：1次/秒。
接口更新时间：2023-09-05 09:16:10。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribePeakValue |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-01-25 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| MetricName | 否 | 否 | String | 五个值可选：<br>access-峰值qps<br>down-下行峰值带宽<br>up-上行峰值带宽<br>attack-Web攻击总数<br>cc-CC攻击总数趋势图 |
| FromTime | 是 | 否 | Datetime | 查询起始时间 |
| ToTime | 是 | 否 | Datetime | 查询结束时间 |
| Domain | 否 | 否 | String | 需要查询的域名，当前用户所有域名可以不传 |
| Edition | 否 | 否 | String | 只有两个值有效，sparta-waf，clb-waf，不传则不过滤 |
| InstanceID | 否 | 否 | String | WAF实例ID，不传则不过滤 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Down | Uint64 | 下行带宽峰值，单位B |
| Attack | Uint64 | Web攻击总数 |
| Cc | Uint64 | CC攻击总数 |
| Access | Uint64 | QPS峰值 |
| Up | Uint64 | 上行带宽峰值，单位B |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| MissingParameter | |
| UnknownParameter | |
| InternalError | |
| UnauthorizedOperation | |
| ResourceNotFound | |
| LimitExceeded | |
| ResourceUnavailable | |
| ResourceInsufficient | |
| FailedOperation | |
| ResourceInUse | |
| ResourcesSoldOut | |
| InvalidParameter.InvalidCertificate | |
| InvalidParameter.QueryCertBySSLIDFailed | |
| UnsupportedOperation | |
| AuthFailure | |
| RequestLimitExceeded | |
| OperationDenied | |
| FailedOperation.CLSInternalError |