根据防护实例 ID 和 IP 地址查询特定时间范围内的入向流量数据。入向流量是指从请求端流向 DDoS 原生防护实例的流量。
注意事项
调用时请将{region}替换成实际地域 ID,地域详情参见地域信息。
请求说明
- 请求方式:GET
- 请求地址:https://origin-defence.{region}.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://origin-defence.{region}.volcengineapi.com/?Action=DescInFlow&Version=2022-01-01&InsId=20
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescInFlow",
"Version": "2022-01-01",
"Service": "origin-defence",
"Region": "cn-beijing"
},
"Result": {
"InKBpsFlow": [
{
"Time": "1718885520",
"Value": 111
},
{
"Time": "1718885580",
"Value": 120
}
],
"InPktsFlow": [
{
"Time": "1718885520",
"Value": 31
},
{
"Time": "1718885580",
"Value": 35
}
],
"PeakInKBps": 150,
"PeakInPps": 40
}
}