AI 助理
备案控制台
文档
产品文档
输入文档关键字查找
首页 网络智能服务 开发参考 统一流量分析API使用教程 GetNisNetworkRanking

GetNisNetworkRanking

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

GetNisNetworkRanking 支持通过排序算法和数据处理能力，对流经不同云网络资源（如EIP、 NAT、TR、GA等）的流量进行排名分析，以及对阿里云性能观测的探测指标进行排序，帮助您快速识别网络瓶颈、优化资源配置和提升整体网络效能。本文为您介绍不同场景下调用GetNisNetworkRanking接口各参数配置情况。

分析场景

调试入口

调试API入口为：网络智能服务调试入口

NAT网关SNAT IP流量分析场景

说明

支持最大查询时间跨度为24小时。

请求参数

名称

类型

必填

描述

RegionNo

string

是

资源所在地域。

ResourceType

string

是

固定选择NAT，表示查询SNAT转发实时数据排名。

Direction

string

是

基于阿里云资源的网络流量方向，取值：

  • in：流入资源的流量方向。

  • out：流出资源的流量方向。

GroupBy

string

是

指定指标排名的维度，默认为Tuple1，表示按ECS私网IP维度的聚合分析。

OrderBy

string

是

指定进行排名的指标，取值：

  • bps：每秒比特数。

  • pps：每秒包数。

  • ActiveSessionCount：并发会话数。

  • NewSessionPerSecond：每秒新建会话数。

Filter

object[]

是

过滤信息。

Name

string

是

过滤条件。取值：InstanceId，表示NAT网关实例ID。

Value

string

是

NAT网关实例ID的值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

array

云网络指标排名数据集合。

IP

string

ECS实例的私有IP。

InBps

double

入方向平均带宽。

InPps

double

入方向平均包速率。

OutBps

double

出方向平均带宽。

OutPps

double

出方向平均包速率。

NewSessionPerSecond

double

每秒新建连接数。

ActiveSessionCount

double

并发连接数。

公网流量分析场景

说明

支持最大查询时间跨度为24小时。

请求参数

名称

类型

必填

描述

RegionNo

string

是

资源所在地域。

ResourceType

string

是

查询公网场景数据排名，取值：

  • AccessInternetIpV4：所有阿里云公网类型IPv4。

  • AccessInternetIpV4Limited：所有受地域限速的阿里云公网类型IPv4。

  • ElasticIP: 弹性公网EIP（IPv4）。

  • PublicIPEcs: 绑定在ECS的固定公网IP（IPv4）。

  • PublicIPClb: 绑定在CLB的固定公网IP（IPv4）。

  • GA：全球加速。

Direction

string

是

基于阿里云资源的网络流量方向，取值：

  • in：流入资源的流量方向。

  • out：流出资源的流量方向。

GroupBy

string

是

指定指标排名的维度，取值：

  • Tuple1：表示一元组，按资源端IP粒度聚合流量进行分析。

  • Tuple2：表示二元组，按网络流量的源IP和目的IP聚合进行分析。

  • Tuple5：表示五元组，按网络流量的源IP、目的IP、源端口、目的端口以及协议进行分析。

  • Protocol: 按协议类型维度进行聚合分析。

  • SourcePort: 按源端口维度进行聚合分析。

  • DestinationPort: 按目的端口维度进行聚合分析。

  • IpPair：按源和目的IP进行聚合分析。

  • Country：按客户端国家维度进行聚合分析。

  • City：按客户端城市维度进行聚合分析。

  • ISP：按客户端运营商维度进行聚合分析。

  • ASN：按客户端运营商ASN维度进行聚合分析。

  • CityASN：按客户端城市和运营商维度进行聚合分析。

OrderBy

string

是

指定进行排名的指标，取值：

  • ByteCount：累计字节数。

  • PacketCount：累计包数。

  • rtt：TCP协议建立连接时的往返延迟。

  • RetransmitRate：重传率。

Filter

object[]

否

过滤信息。

Name

string

否

过滤条件，取值：

  • InstanceId：公网实例ID，如EIP ID、CLB ID、ECS ID、GA ID。

  • Product：公网场景的产品，枚举为：EIP、CLB、ECS、GA、VPN。

  • VpcId：专有网络ID。

  • SourceSubnet：源IP网段，目前只支持/32网段。

  • DestinationSubnet：目的端IP网段，目前只支持/32网段。

  • SourcePort：源端口。

  • DestinationPort：目的端口。

  • Protocol：协议。

  • Country：客户端所在国家。

  • Province：客户端所在省份。

  • City：客户端所在城市。

  • Isp：客户端所属运营商。

  • Asn：客户端所属运营商自治编号。

说明

只有当GroupBy参数为Tuple5、Protocol、SourcePort、DestinationPort时，才能指定SourcePort、DestinationPort、Protocol过滤条件。

Value

string

否

过滤条件对应的过滤值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

array

云网络指标排名数据集合。

RegionNo

string

资源所在地域。

InstanceId

string

公网实例ID。

SourceIp

string

源IP地址。

SourcePort

string

源端口。

SourceIsp

string

源运营商。

DestinationIp

string

目的IP地址。

DestinationPort

string

目的端口。

DestinationIsp

string

目的运营商。

Protocol

string

网络协议编号。

Country

string

客户端所在国家。

City

string

客户端所在城市。

Asn

string

客户端所属运营商自治编号。

ByteCount

double

累计字节数。

PacketCount

double

累计包数。

RTT

double

平均TCP建连时延，单位ms。

RetransmitRate

double

平均重传率。

跨域流量分析场景

说明

支持最大查询时间跨度为24小时。

请求参数

名称

类型

必填

描述

RegionNo

string

是

转发路由器所在地域。

ResourceType

string

是

固定选择TR，表示查询跨域流量详情数据排名。

Direction

string

是

选择out，跨域流量分析只采集出向流量。

GroupBy

string

是

指定指标排名的维度，取值：

  • Tuple1：表示一元组，按资源端IP粒度聚合流量进行分析。

  • Tuple2：表示二元组，按网络流量的源IP和目的IP聚合进行分析。

  • Tuple5：表示五元组，按网络流量的源IP、目的IP、源端口、目的端口以及协议进行分析。

  • Protocol: 按协议类型维度进行聚合分析。

  • SourcePort: 按源端口维度进行聚合分析。

  • InstanceId：按CEN实例ID进行聚合分析。

  • RegionPair：按CEN联通的两端Region进行聚合分析。

OrderBy

string

是

指定进行排名的指标，取值：

  • ByteCount：累计字节数。

  • PacketCount：累计包数。

Filter

object[]

否

过滤信息。

-Name

string

否

过滤条件，取值：

  • InstanceId：CEN实例ID。

  • BandwidthPackageId：CEN带宽包实例ID。

  • DestinationRegionNo：目的端地域。

  • SourceIp：源IP地址。

  • DestinationIp：目的端IP地址。

  • SourcePort：源端口。

  • DestinationPort：目的端口。

  • Protocol：协议。

说明

只有当GroupBy参数为Tuple5、Protocol、SourcePort时，才能指定SourcePort、DestinationPort、Protocol过滤条件。

-Value

string

否

过滤条件对应的过滤值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

array

云网络指标排名数据集合。

RegionNo

string

转发路由器所在地域。

InstanceId

string

CEN实例ID

SourceIp

string

源IP地址。

SourcePort

string

源端口。

DestinationIp

string

目的IP地址。

DestinationPort

string

目的端口。

DestinationRegionNo

string

目的地域。

Protocol

string

网络协议编号。

ByteCount

double

累计字节数。

PacketCount

double

累计包数。

混合云流量分析场景

说明

支持最大查询时间跨度为24小时。

请求参数

名称

类型

必填

描述

RegionNo

string

是

边界路由器所在地域。

ResourceType

string

是

固定选择VBR，表示查询混合云流量详情数据排名。

Direction

string

是

基于阿里云的网络流量方向，取值：

  • in：流入阿里云的流量方向。

  • out：流出阿里云的流量方向。

GroupBy

string

是

指定指标排名的维度，取值：

  • Tuple1：表示一元组，按资源端IP粒度聚合流量进行分析。

  • Tuple2：表示二元组，按网络流量的源IP和目的IP聚合进行分析。

  • Tuple5：表示五元组，按网络流量的源IP、目的IP、源端口、目的端口以及协议进行分析。

  • Protocol: 按协议类型维度进行聚合分析。

  • SourcePort: 按源端口维度进行聚合分析。

  • DestinationPort：按目的端口维度进行聚合分析。

OrderBy

string

是

指定进行排名的指标，取值：

  • ByteCount：累计字节数。

  • PacketCount：累计包数。

Filter

object[]

否

过滤信息。

-Name

string

否

过滤条件，取值：

  • InstanceId：CEN实例ID。

  • VbrId：边界路由器实例ID。

  • AttachmentId：转发路由器链接ID。

  • SourceIp：源IP地址。

  • DestinationIp：目的端IP地址。

  • SourcePort：源端口。

  • DestinationPort：目的端口。

  • Protocol：协议。

说明

只有当GroupBy参数为Tuple5、Protocol、SourcePort、DestinationPort时，才能指定SourcePort、DestinationPort、Protocol过滤条件。

-Value

string

否

过滤条件对应的过滤值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

array

云网络指标排名数据集合。

InstanceId

string

CEN实例ID

AttachmentId

string

转发路由器链接ID。

VbrId

string

边界路由器实例ID。

SourceIp

string

源IP地址。

SourcePort

string

源端口。

DestinationIp

string

目的IP地址。

DestinationPort

string

目的端口。

Protocol

string

网络协议编号。

ByteCount

double

累计字节数。

PacketCount

double

累计包数。

公网性能观测大盘场景

说明

不需要指定时间，查询最新探测结果

请求参数

名称

类型

必填

描述

RegionNo

string

是

探测源所在阿里云地域。

ResourceType

string

是

固定选择InternetProbing，表示查询公网性能观测排名。

Direction

string

是

固定选择out，探测方向为出向流量。

GroupBy

string

是

指定指标排名的维度，枚举如下：

  • Country：探测的国家。

  • CountryIsp：探测的国家及运营商。

  • Province：探测的省份。

  • ProvinceIsp：探测的省份及运营商。

OrderBy

string

是

指定进行排名的指标，取值：rtt，探测的往返延迟。

Filter

object[]

否

过滤信息。

-Name

string

否

过滤条件，取值：

  • Country：探测的国家。

  • Province：探测的省份。

  • Isp：探测的运营商。

-Value

string

否

过滤条件对应的过滤值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

array

云网络指标排名数据集合。

Country

string

探测的国家。

Province

string

探测的省份。

Isp

string

探测的运营商。

RTT

double

探测的往返延迟，单位ms。

跨可用区内网性能观测大盘场景

说明

支持最大查询时间跨度为1小时。

请求参数

名称

类型

必填

描述

RegionNo

string

是

阿里云地域。

ResourceType

string

是

固定选择IntranetProbing，表示查询跨可用区性能观测排名。

Direction

string

是

因需在Filter参数内指定探测源或目的，意味着方向已定，所以选择in或out无影响。

GroupBy

string

是

指定指标排名的维度，取值：ZonePair，按可用区对进行聚合分析。

OrderBy

string

是

指定进行排名的指标，取值：rtt，探测的往返延迟。

Filter

object[]

是

过滤信息。

-Name

string

是

过滤条件，取值：

  • SourceZone：探测的源可用区。

  • DestinationZone：探测的目的可用区。

说明

SourceZone和DestinationZone必须至少选择一个。

-Value

string

是

过滤条件对应的过滤值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

array

云网络指标排名数据集合。

SourceZone

string

探测的源可用区。

DestinationZone

string

探测的目的可用区。

RTT

double

探测的往返延迟，单位ms。

跨地域内网性能观测大盘场景

说明

支持最大查询时间跨度为24小时，不指定时默认查询最近1小时。

请求参数

名称

类型

必填

描述

RegionNo

string

是

阿里云地域。

ResourceType

string

是

固定选择IntranetProbing，表示查询跨地域性能观测排名。

Direction

string

是

探测方向，取值：

  • in：以RegionNo为目的的探测。

  • out：以RegionNo为源的探测。

GroupBy

string

是

指定指标排名的维度，取值：RegionPair，按地域区对进行聚合分析。

OrderBy

string

是

指定进行排名的指标，取值：rtt，探测的往返延迟。

Filter

object[]

否

过滤信息。

-Name

string

否

过滤条件，取值：DestinationRegionNo，当Direction为out时，可指定此参数表示探测的目的地域。

-Value

string

否

目的地域。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

array

云网络指标排名数据集合。

RegionNo

string

探测的源地域。

DestinationRegionNo

string

探测的目的地域。

RTT

double

探测的往返延迟，单位ms。

上一篇：统一流量分析API使用教程下一篇：GetNisNetworkMetrics
文档推荐