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

GetNisNetworkMetrics

更新时间：
产品详情
我的收藏

GetNisNetworkMetrics支持指定NIS网络分析场景，获取详细监控指标趋势数据，包括流量分析场景下的流量指标趋势数据，以及性能观测场景下的性能指标趋势数据等。本文为您介绍不同场景下调用GetNisNetworkMetrics接口各参数配置情况。

说明

API数据跨度6小时同步一次，6小时后才可查询当前网络分析数据。

分析场景

调试入口

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

NAT网关场景

说明

支持最大查询时间跨度为24小时，不指定时默认查询最近1小时，查询的数据结果为1分钟1条。

请求参数

名称

类型

必填

描述

RegionNo

string

是

资源所在地域。

ResourceType

string

是

固定选择NAT，表示查询SNAT下单IP监控趋势。

MetricName

string

是

指定查询趋势的指标，取值：

  • bps：每秒比特数。

  • pps：每秒包数。

  • ActiveSessionCount：并发会话数。

  • NewSessionPerSecond：每秒新建会话数。

Dimensions

object[]

是

过滤信息。

-Name

string

是

过滤条件，取值：

  • Direction：基于阿里云资源的网络流量方向，该参数必须配置。

  • InstanceId：表示NAT实例ID，该参数必须配置。

  • Ip：网卡IP，该参数必须配置。

-Value

string

是

过滤条件对应的过滤值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

object

云网络指标趋势数据对象

Metrics

array

指标趋势数据集合

-TimeStamp

long

毫秒时间戳。

-Value

double

入参MetricName对应的指标值。

Unit

String

表示Value的单位。

公网流量分析场景

说明

支持最大查询时间跨度为24小时，不指定时默认查询最近1小时，查询的数据结果为1分钟1条。

请求参数

名称

类型

必填

描述

RegionNo

string

是

资源所在地域。

ResourceType

string

是

查询公网场景监控趋势，取值：

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

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

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

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

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

  • GA：全球加速。

MetricName

string

是

指定查询趋势的指标，取值：

  • bps：每秒比特数。

  • pps：每秒包数。

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

  • RetransmitRate：重传率。

Dimensions

object[]

是

过滤信息。

-Name

string

是

过滤条件，取值：

  • Direction：基于阿里云资源的网络流量方向，必须指定。

  • 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：客户端所属运营商自治编号。

-Value

string

否

过滤条件对应的过滤值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

object

云网络指标趋势数据对象

Metrics

array

指标趋势数据集合

-TimeStamp

long

毫秒时间戳。

-Value

double

入参MetricName对应的指标值。

Unit

String

表示Value的单位。

跨域流量分析场景

说明

支持最大查询时间跨度为24小时，不指定时默认查询最近1小时，查询的数据结果为1分钟1条。

请求参数

名称

类型

必填

描述

RegionNo

string

是

转发路由器所在地域。

ResourceType

string

是

固定选择TR，表示查询跨域流量监控趋势。

MetricName

string

是

指定查询趋势的指标，取值：

  • bps：每秒比特数。

  • pps：每秒包数。

Dimensions

object[]

是

过滤信息。

-Name

string

是

过滤条件，取值：

  • InstanceId：CEN实例ID。

  • BandwidthPackageId：CEN带宽包实例ID。

  • DestinationRegionNo：目的端地域。

  • SourceIp：源IP地址。

  • DestinationIp：目的端IP地址。

  • SourcePort：源端口。

  • DestinationPort：目的端口。

  • Protocol：协议。

-Value

string

是

过滤条件对应的过滤值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

object

云网络指标趋势数据对象

Metrics

array

指标趋势数据集合

-TimeStamp

long

毫秒时间戳。

-Value

double

入参MetricName对应的指标值。

Unit

String

表示Value的单位。

混合云流量分析场景

说明

支持最大查询时间跨度为24小时，不指定时默认查询最近1小时，查询的数据结果为1分钟1条。

请求参数

名称

类型

必填

描述

RegionNo

string

是

边界路由器所在地域。

ResourceType

string

是

固定选择VBR，表示查询混合云流量监控趋势。

MetricName

string

是

指定查询趋势的指标，取值：

  • bps：每秒比特数。

  • pps：每秒包数。

Dimensions

object[]

是

过滤信息。

-Name

string

是

过滤条件，取值：

  • Direction：基于阿里云资源的网络流量方向，必须指定。

  • InstanceId：CEN实例ID。

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

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

  • SourceIp：源IP地址。

  • DestinationIp：目的端IP地址。

  • SourcePort：源端口。

  • DestinationPort：目的端口。

  • Protocol：协议。

-Value

string

是

过滤条件对应的过滤值。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

object

云网络指标趋势数据对象

Metrics

array

指标趋势数据集合

-TimeStamp

long

毫秒时间戳。

-Value

double

入参MetricName对应的指标值。

Unit

String

表示Value的单位。

公网性能观测大盘场景

说明

支持最大查询时间跨度为24小时，不指定时默认查询最近1小时，查询的数据结果为1分钟1条。

请求参数

名称

类型

必填

描述

RegionNo

string

是

探测源所在阿里云地域。

ResourceType

string

是

固定选择InternetProbing，表示查询公网性能监控趋势。

MetricName

string

是

指定查询趋势的指标，取值：rtt，探测的往返延迟。

Dimensions

object[]

是

过滤信息。

-Name

string

是

过滤条件，取值：

  • Country：探测的国家。

  • Province：探测的省份

  • Isp：探测的运营商。

说明

以上参数至少配置其中一个。

-Value

string

是

过滤条件对应的过滤值，示例如下：

  • Country：China

  • Province：Zhejiang

  • Isp：阿里巴巴

说明

国家，省份格式为首字母大写，运营商参数与控制台显示名称一致即可。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

object

云网络指标趋势数据对象

Metrics

array

指标趋势数据集合

-TimeStamp

long

毫秒时间戳。

-Value

double

入参MetricName对应的指标值。

Unit

String

表示Value的单位。

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

说明

  • 查询时间长度超过5天时，查询数据结果为1天1条。

  • 查询时间长度超过1天时，查询数据结果为1小时1条。

  • 查询时间长度小于1天时，查询数据结果为5分钟1条。

请求参数

名称

类型

必填

描述

RegionNo

string

是

阿里云地域。

ResourceType

string

是

固定选择IntranetProbing，表示查询跨可用区性能监控趋势。

MetricName

string

是

指定查询趋势的指标，取值：rtt，探测的往返延迟。

Dimensions

object[]

是

过滤信息。

-Name

string

是

过滤条件，取值：

  • SourceZone：探测的源可用区，必须指定。

  • DestinationZone：探测的目的可用区，必须指定。

-Value

string

是

过滤条件对应的过滤值，示例如下：

  • SourceZone：cn-hangzhou-j

  • DestinationZone：cn-hangzhou-k

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

object

云网络指标趋势数据对象

Metrics

array

指标趋势数据集合

-TimeStamp

long

毫秒时间戳。

-Value

double

入参MetricName对应的指标值。

Unit

String

表示Value的单位。

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

说明

  • 查询时间长度超过5天时，查询数据结果为1天1条。

  • 查询时间长度超过1天时，查询数据结果为1小时1条。

  • 查询时间长度小于1天时，查询数据结果为5分钟1条。

请求参数

名称

类型

必填

描述

RegionNo

string

是

阿里云地域。

ResourceType

string

是

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

Direction

string

是

探测方向，取值：

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

  • out：以RegionNo为源的探测。

MetricName

string

是

指定查询趋势的指标，取值：rtt，探测的往返延迟。

Dimensions

object[]

否

过滤信息。

-Name

string

否

过滤条件，取值：DestinationRegionNo，探测的目的地域，该参数必须指定。

-Value

string

否

目的地域ID，示例如下：

DestinationRegionNo：cn-shenzhen

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

object

云网络指标趋势数据对象

Metrics

array

指标趋势数据集合

-TimeStamp

long

毫秒时间戳。

-Value

double

入参MetricName对应的指标值。

Unit

String

表示Value的单位。

公网地域级带宽场景

说明

支持最大查询时间跨度为24小时，不指定时默认查询最近1小时，查询的数据结果为1分钟1条。

请求参数

名称

类型

必填

描述

RegionNo

string

是

阿里云地域。

ResourceType

string

是

固定选择AccessInternetIpV4Limited，表示查询地域限速的公网监控趋势。

MetricName

string

是

指定获取的指标，取值：

  • RatelimitDropPps：限速丢包速率

  • bps：每秒比特数。

  • pps：每秒包数。

Dimensions

object[]

是

过滤信息

-Name

string

是

过滤条件，取值：direction，基于阿里云资源的网络流量方向。

-Value

string

是

过滤条件对应的过滤值，取值：

  • in：流入阿里云当前地域的流量方向。

  • out：流出阿里云当前地域的流量方向。

返回参数

名称

类型

描述

RequestId

string

请求ID。

Data

object

云网络指标趋势数据对象

Metrics

array

指标趋势数据集合

-TimeStamp

long

毫秒时间戳。

-Value

double

入参MetricName对应的指标值。

Unit

String

表示Value的单位。

上一篇：GetNisNetworkRanking下一篇：服务支持