调用DescribePortFlowList查询DDoS高防实例的流量数据列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribePortFlowList

要执行的操作。取值:DescribePortFlowList

RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值:

  • cn-hangzhou(默认):表示中国内地,对应DDoS高防(新BGP)实例。
  • ap-southeast-1:表示非中国内地,对应DDoS高防(国际)实例。
ResourceGroupId String rg-acfm2pz25js****

DDoS高防实例在资源管理服务中所属的资源组ID。默认为空,即属于默认资源组。

关于资源组的更多信息,请参见创建资源组

EndTime Long 1583683200

设置查询结束时间。使用时间戳格式,单位:秒。

说明 必须设置成整点分钟。
StartTime Long 1582992000

设置查询开始时间。使用时间戳格式,单位:秒。

说明 必须设置成整点分钟。
Interval Integer 1000

设置返回数据的步长,单位为秒,即每隔多少秒返回一个结果。查询时间范围(由StartTimeEndTime决定)不同,支持的步长取值范围不同,设置建议如下:

  • 查询时间范围不大于1小时,建议最小步长为60秒,最大不超过查询时间范围。
  • 查询时间范围大于1小时但不超过6小时,建议最小步长为600秒,最大不超过查询时间范围。
  • 查询时间范围大于6小时但不超过24小时,建议最小步长为1800秒,最大不超过查询时间范围。
  • 查询时间范围大于24小时但不超过7天,建议最小步长为3600秒,最大不超过查询时间范围。
  • 查询时间范围大于7天但不超过15天,建议最小步长为14400秒,最大不超过查询时间范围。
  • 查询时间范围大于15天,建议最小步长为43200秒,最大不超过查询时间范围。
InstanceIds.N String ddoscoo-cn-zz120cjv****

DDoS高防实例的ID。

说明 您可以调用 DescribeInstanceIds查询所有DDoS高防实例的ID信息。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String FFC77501-BDF8-4BC8-9BF5-B295FBC3189B

本次请求的ID。

PortFlowList Array of PortFlow

查询到的流量数据。

Index Long 0

返回数据的索引号。

Time Long 1582992000

统计时间。时间戳格式,单位:秒。

InPps Long 2934

入方向包转发率,单位:pps。

InBps Long 2176000

入方向带宽,单位:bps。

Region String cn

访问流量来源地区。取值:

  • cn:中国内地。
  • alb-ap-northeast-1-gf-x:日本。
  • alb-ap-southeast-gf-x:新加坡。
  • alb-cn-hongkong-gf-x:中国香港。
  • alb-eu-central-1-gf-x:德国。
  • alb-us-west-1-gf-x:美国西部。
说明 cn以外的取值只有在DDoS高防(国际)服务( RegionIdap-southeast-1)中提供。
OutPps Long 5

出方向包转发率,单位:pps。

AttackPps Long 0

攻击包转发率,单位:pps。

OutBps Long 4389

出方向带宽,单位:bps。

AttackBps Long 0

攻击带宽,单位:bps。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribePortFlowList
&ResourceGroupId=rg-acfm2pz25js****
&EndTime=1583683200
&StartTime=1582992000
&Interval=1000
&InstanceIds=["ddoscoo-cn-zz120cjv****"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribePortFlowListResponse>
    <RequestId>FFC77501-BDF8-4BC8-9BF5-B295FBC3189B</RequestId>
    <PortFlowList>
        <Index>0</Index>
        <Time>1582992000</Time>
        <InPps>2934</InPps>
        <InBps>2176000</InBps>
        <Region>cn</Region>
        <OutPps>5</OutPps>
        <AttackPps>0</AttackPps>
        <OutBps>4389</OutBps>
        <AttackBps>0</AttackBps>
    </PortFlowList>
</DescribePortFlowListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "FFC77501-BDF8-4BC8-9BF5-B295FBC3189B",
  "PortFlowList" : [ {
    "Index" : 0,
    "Time" : 1582992000,
    "InPps" : 2934,
    "InBps" : 2176000,
    "Region" : "cn",
    "OutPps" : 5,
    "AttackPps" : 0,
    "OutBps" : 4389,
    "AttackBps" : 0
  } ]
}

错误码

访问错误中心查看更多错误码。