文档

GetNisNetworkRanking - 获取云网络指标排名

更新时间:

支持通过排序算法和数据处理能力,对流经不同云网络资源的流量进行排名分析,以及对阿里云性能观测的探测指标进行排序,帮助您快速识别网络瓶颈、优化资源配置和提升整体网络效能。

接口说明

支持分析场景:

  • NAT 网关 SNAT IP 流量分析场景
  • 公网流量分析场景
  • 跨域流量分析场景
  • 混合云流量分析场景
  • 公网性能观测大盘场景
  • 跨可用区内网性能观测大盘场景
  • 跨地域内网性能观测大盘场景
各场景的具体使用方式请参见此文档

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
nis:GetNisNetworkRankingnone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RegionNostring

资源所在地域。

cn-beijing
ResourceTypestring

按流量转发所使用的阿里云网络资源类型进行分析,取值:

  • AccessInternetIpV4:所有阿里云公网类型 IPv4。
  • AccessInternetIpV4Limited:所有受地域限速的阿里云公网类型 IPv4。
  • ElasticIP:弹性公网 EIP(IPv4)。
  • PublicIpEcs:绑定在 ECS 的固定公网 IP(IPv4)。
  • PublicIpClb:绑定在 CLB 的固定公网 IP(IPv4)。
  • NAT:通过 SNAT 的访问公网流量。
  • TR:流经云企业网转发路由器的流量。
  • TRAttachment:流经云企业网连接实例的流量,包括地域内连接和跨地域连接。
  • VBR:流经边界路由器的流量。
  • GA:流经全球加速的流量。
  • InternetProbing:公网探测质量数据。
  • IntranetProbing:内网探测质量数据。
AccessInternetIpV4
Directionstring

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

  • in:流入资源的流量方向。
  • out:流出资源的流量方向。

注意 跨域流量分析因只采集出向流量,所以传入 in 也以 out 处理。 地域内性能观测和地域间性能观测因需在 Filter 内指定源或目的,所以指定 Direction 无效。

in
GroupBystring

指定指标排名的维度,各场景取值:
完整流数据排名分析:

  • Tuple1:表示一元组,提供云端 IP 粒度完整流数据排名分析。
  • Tuple2:表示二元组,提供源和目的 IP 粒度完整流数据排名分析。
  • Tuple5:表示五元组,提供源和目的 IP、端口、协议粒度完整流数据排名分析。

流量统计排名分析:

  • Protocol:按协议类型统计流量。
  • SourcePort:按源端口统计流量。
  • DestinationPort:按目的端口统计流量。
  • InstanceId:按云上资源 ID 统计流量。
  • IpPair:按源和目的 IP 对统计流量。
  • Country:按客户端国家来源统计流量。
  • Province:指定客户端省份来源统计流量。
  • City:按客户端城市来源统计流量。
  • ISP:按客户端运营商来源统计流量。
  • ASN:按客户端运营商 ASN 来源统计流量。
  • CityASN:按客户端城市和运营商 ASN 来源统计流量。
  • RegionPair:按云企业网跨地域访问统计流量。

网络访问性能排名分析:

  • CountryIsp:指定 Region 访问互联网国家和运营商性能排名。
  • Province:指定 Region 访问国内省份性能排名。
  • ProvinceIsp:指定 Region 访问国内省份和运营商性能排名。
  • RegionPair:阿里云跨地域互访性能排名。
  • ZonePair:指定地域内可用区互访性能排名。
Protocol
OrderBystring

指定公网流量进行排名的指标。大小写敏感,取值:

  • bps:每秒比特数。
  • pps:每秒包数。
  • ByteCount:累计字节数。
  • PacketCount:累计包数。
  • rtt:tcp 协议建立连接时的往返延迟。
  • RetransmitRate:重传率。
  • RatelimitDropPps:限速丢包速率。
  • ActiveSessionCount:并发会话数。
  • NewSessionPerSecond:每秒新建会话数。
bps
Filterarray<object>

支持进一步指定流量的过滤条件,进行聚焦性流量分析。

object

查询资源时的筛选条件列表。

Namestring

过滤条件的名字。

instanceId
Valuestring

过滤条件的值。

lb-2zxxxxz1d
BeginTimelong

起始时间戳,单位 ms。未指定时默认查最近 1 小时。

1684373600099
EndTimelong

结束时间戳,单位 ms。未指定时默认查最近 1 小时。只指定了 BeginTime 时查 BeginTime 之后的 1 小时。

1684379093000
Sortstring

排序方式,默认 desc,取值:

  • asc:按正序排序。
  • desc:按逆序排序。
desc
TopNinteger

展示排序靠前的数据。默认值:10。表示默认展示排序前 10 的数据。最大值:100

10
UseCrossAccountboolean

是否使用多账号访问模式,保留参数,目前不支持。

false
AccountIdsarray

显式传递子账号 ID。

string

成员账号 ID 列表。

118639953821****

返回参数

名称类型描述示例值
object

RpcResponse<ArrayList>

RequestIdstring

请求 ID。

A7F0D6EC-E19E-58AC-AC9F-08036763960F
Dataarray<object>

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

object

云网络指标排名单行数据。

RegionNostring

阿里云地域 ID。

cn-shenzhen
InstanceIdstring

各场景下表示对应的云上资源实例 ID,如跨域流量分析场景表示 CenID,公网场景表示 EipId、EcsId、ClbId 等。

eip-sample*
BandwidthPackageIdstring

带宽包实例 ID。

cbwp-sample*
SourceIpstring

源端 IP。

42.120.XX.XX
SourcePortstring

源端端口。

443
SourceIspstring

源端运营商。

移动
DestinationIpstring

目的端 IP。

2.2.XX.XX
DestinationPortstring

目的端端口。

80
DestinationIspstring

目的端运营商。

阿里云
Protocolstring

网络协议。

6
Countrystring

客户端所在国家。

中国
Provincestring

客户端所在省份/州。

四川省
Citystring

客户端所在的城市。

成都市
Ispstring

客户端运营商。

移动
Asnstring

客户端运营商的自治系统编号。

129103
IPstring

IP 地址。

120.238.XX.XX
DestinationRegionNostring

目的端地域 ID。

cn-hangzhou
VbrIdstring

边界路由器实例 ID。

vbr-sample*
AttachmentIdstring

转发路由器链接 ID。

tr-sample*
SourceZonestring

探测的源可用区。

cn-hangzhou-a
DestinationZonestring

探测的目的可用区。

cn-hangzhou-b
ByteCountdouble

流量数(Byte)。

1024
PacketCountdouble

流量包数。

66
RTTdouble

延迟,单位 ms

23
RetransmitRatedouble

TCP 报文的重传率。

0.1
InBpsdouble

入方向带宽,单位:bps。

10
InPpsdouble

入方向包速率。单位:个/秒。

3
OutBpsdouble

出方向带宽,单位:bps。

88
OutPpsdouble

出方向包速率。单位:个/秒。

8
NewSessionPerSeconddouble

新建连接数。单位:个/秒。

18
ActiveSessionCountdouble

并发连接数。单位:个。

66

示例

正常返回示例

JSON格式

{
  "RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
  "Data": [
    {
      "RegionNo": "cn-shenzhen",
      "InstanceId": "eip-sample*",
      "BandwidthPackageId": "cbwp-sample*",
      "SourceIp": "42.120.XX.XX",
      "SourcePort": "443",
      "SourceIsp": "移动",
      "DestinationIp": "2.2.XX.XX",
      "DestinationPort": "80",
      "DestinationIsp": "阿里云",
      "Protocol": "6",
      "Country": "中国",
      "Province": "四川省",
      "City": "成都市",
      "Isp": "移动",
      "Asn": "129103",
      "IP": "120.238.XX.XX",
      "DestinationRegionNo": "cn-hangzhou",
      "VbrId": "vbr-sample*",
      "AttachmentId": "tr-sample*",
      "SourceZone": "cn-hangzhou-a",
      "DestinationZone": "cn-hangzhou-b",
      "ByteCount": 1024,
      "PacketCount": 66,
      "RTT": 23,
      "RetransmitRate": 0.1,
      "InBps": 10,
      "InPps": 3,
      "OutBps": 88,
      "OutPps": 8,
      "NewSessionPerSecond": 18,
      "ActiveSessionCount": 66
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.BeginTimeAndEndTimeIt only supports querying data for up to 24 hours: %s.最大支持查询24小时数据。
400OperationFailed.DataTooMuchToo much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.指定条件下查询的数据过多,请缩短查询时间、指定更精确过滤条件或者稍后重试。
400IllegalParam.OrderByThe specified param of orderBy (%s) is invalid.指定的排序字段(%s)不合法。
400IllegalParam.ResourceTypeThe specified resourceType (%s) is invalid.指定的ResourceType变量值(%s)不存在。
400IllegalParam.GroupByThe specified param of GroupBy (%s) is invalid.指定的分组字段(%s)不合法。
400IllegalParam.DirectionThe specified direction (%s) is invalid.指定的Direction参数不合法,请修改。
400IllegalParam.Filter.InstanceIdThe specified InstanceId(%s) is illegal.指定的InstanceId(%s)参数非法。
400IllegalParam.BeginTimeAndEndTime5MIt only supports querying data for up to 5 minute when TupleType is 5 and the CloudIp and OtherIp are both empty: %s.当TupleType=5且CloudIp、OtherIp都是空时,只支持查询最长5分钟范围的数据。
404ResourceNotFound.InstanceIdThe specified InstanceId(%s) does not exist.指定的InstanceId(%s)不存在。
404ResourceNotFound.IpSetsThe specified instance does not exist or does not have any acceleration region.指定的实例不存在或者没有加速区域。

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

变更历史

变更时间变更内容概要操作
暂无变更历史