根据防护实例 ID 和 IP 地址查询特定时间范围内的入向流量数据。入向流量是指从请求端流向 DDoS 原生防护实例的流量。
请求说明
- 请求方式：GET
- 请求地址：https://open.volcengineapi.com/?Action=DescInFlow&Version=2022-01-01
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | DescInFlow | 接口名称。当前 API 的名称为 DescInFlow。 |
| Version | String | 是 | 2022-01-01 | 接口版本。当前 API 的版本为 2022-01-01。 |
| InsId | Integer | 是 | 20 | 防护实例的 ID，可调用DescInstanceList接口获取具体值。 |
| Ip | String | 否 | 180.184.180.** | 防护资源 IP，为空时表示查询当前实例下所有防护资源 IP。 |
| BeginTime | Integer | 否 | 1718885400 | 查询起始时间，秒级时间戳。为空时则表示 30 分钟前。 |
| EndTime | Integer | 否 | 1718889000 | 查询结束时间，秒级时间戳。为空时则表示当前时间。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| InKBpsFlow | Array of InKBpsFlow | -- | 入向带宽趋势。 |
| InPktsFlow | Array of InPktsFlow | -- | 入向包速率趋势。 |
| PeakInKBps | Integer | 111 | 入向带宽峰值。 |
| PeakInPps | Integer | 31 | 入向包速率峰值。 |
InKBpsFlow
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Time | String | 1718885520 | 入向带宽数据采集时间，间隔为 60 秒。 |
| Value | Integer | 111 | 该采集时间点的入向带宽值，单位为 Kbps。 |
InPktsFlow
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Time | String | 1718885520 | 入向包速率数据采集时间，间隔为 60 秒。 |
| Value | Integer | 31 | 该采集时间点的入向包速率值，单位为 Pkts。 |
请求示例
GET https://open.volcengineapi.com/?Action=DescInFlow&Version=2022-01-01&InsId=20&Ip=180.184.180.**&BeginTime=1718885400&EndTime=1718889000
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240610T082509Z
X-content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240610/cn-beijing/origin_defence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
返回示例
{
"ResponseMetadata": {
"Action": "DescInFlow",
"Region": "cn-beijing",
"RequestId": "20230604110420****100232280022D31",
"Service": "origin_defence",
"Version": "2022-01-01"
},
"Result": {
"BizKBpsFlow": [
{
"Time": "1718885400",
"Value": 1
},
//此处省略若干节点
{
"Time": "1718885520",
"Value": 111
}
],
"BizPktsFlow": [
{
"Time": "1718885400",
"Value": 1
},
//此处省略若干节点
{
"Time": "1718885520",
"Value": 31
}
],
"PeakBizKBps": 111,
"PeakBizPps": 31
}
}