GetNisNetworkRanking - Network Intelligence Service - Alibaba Cloud Documentation Center

This operation uses sorting algorithms and data processing to analyze and rank traffic across various cloud network resources. It also sorts metrics from Alibaba Cloud performance monitoring probes. This helps you quickly identify network bottlenecks, optimize resource configurations, and improve overall network performance.

Operation description

This operation supports the following analysis scenarios:

Internet performance monitoring dashboard
Cross-zone internal network performance monitoring dashboard
Cross-region internal network performance monitoring dashboard

Internet performance monitoring dashboard scenario

Note

You do not need to specify a time to query the latest probe results.

Request parameters

Name	Type	Required	Description
RegionNo	string	Yes	The Alibaba Cloud region where the monitoring node is located.
ResourceType	string	Yes	Set the value to InternetProbing. This value indicates that you want to query the rankings of Internet performance monitoring.
Direction	string	Yes	Set the value to out. This value indicates that the traffic direction is outbound.
GroupBy	string	Yes	The dimension for ranking metrics. Valid values: Country: the country where the probe is located. CountryIsp: the country and ISP where the probe is located. Province: the province where the probe is located. ProvinceIsp: the province and ISP where the probe is located.
OrderBy	string	Yes	The metric used for ranking. Set the value to rtt, which specifies the response time (RT) of the probe.
Filter	object[]	No	The filter conditions.
-Name	string	No	The filter condition. Valid values: - Country: the country where the probe is located. - Province: the province where the probe is located. - Isp: the ISP of the probe.
-Value	string	No	The value of the filter condition.

Response parameters

Name	Type	Description
RequestId	string	The request ID.
Data	array	A collection of cloud network metric ranking data.
Country	string	The country where the probe is located.
Province	string	The province where the probe is located.
Isp	string	The ISP of the probe.
RTT	double	The RT of the probe. Unit: ms.

Cross-zone internal network performance monitoring dashboard scenario

Note

The maximum time range that you can query is 1 hour.

Request parameters

Name	Type	Required	Description
RegionNo	string	Yes	The Alibaba Cloud region.
ResourceType	string	Yes	Set the value to IntranetProbing. This value indicates that you want to query the rankings of cross-zone performance monitoring.
Direction	string	Yes	You must specify the source or destination of the probe in the Filter parameter. This means the direction is already determined. Therefore, setting this parameter to in or out has no effect.
GroupBy	string	Yes	The dimension for ranking metrics. Set the value to ZonePair, which specifies that aggregation and analysis are performed by zone pair.
OrderBy	string	Yes	The metric used for ranking. Set the value to rtt, which specifies the RT of the probe.
Filter	object[]	Yes	The filter conditions.
-Name	string	Yes	The filter condition. Valid values: - SourceZone: the source zone of the probe. - DestinationZone: the destination zone of the probe. Note: You must specify at least one of SourceZone and DestinationZone.
-Value	string	Yes	The value of the filter condition.

Response parameters

Name	Type	Description
RequestId	string	The request ID.
Data	array	A collection of cloud network metric ranking data.
SourceZone	string	The source zone of the probe.
DestinationZone	string	The destination zone of the probe.
RTT	double	The RT of the probe. Unit: ms.

Cross-region internal network performance monitoring dashboard scenario

Note

The maximum time range that you can query is 24 hours. If you do not specify a time range, data from the last hour is queried by default.

Request parameters

Name	Type	Required	Description
RegionNo	string	Yes	The Alibaba Cloud region.
ResourceType	string	Yes	Set the value to IntranetProbing. This value indicates that you want to query the rankings of cross-region performance monitoring.
Direction	string	Yes	The probe direction. Valid values: in: The probe destination is the region specified by RegionNo. out: The probe source is the region specified by RegionNo.
GroupBy	string	Yes	The dimension for ranking metrics. Set the value to RegionPair, which specifies that aggregation and analysis are performed by region pair.
OrderBy	string	Yes	The metric used for ranking. Set the value to rtt, which specifies the RT of the probe.
Filter	object[]	No	The filter conditions.
-Name	string	No	The filter condition. Set the value to DestinationRegionNo. When Direction is set to out, you can use this parameter to specify the destination region of the probe.
-Value	string	No	The destination region.

Response parameters

Name	Type	Description
RequestId	string	The request ID.
Data	array	A collection of cloud network metric ranking data.
RegionNo	string	The source region of the probe.
DestinationRegionNo	string	The destination region of the probe.
RTT	double	The RT of the probe. Unit: ms.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nis:GetNisNetworkRanking

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionNo	string	Yes	The region where the resource is located.	cn-beijing
ResourceType	string	Yes	The type of the Alibaba Cloud network resource that is used for traffic forwarding. Valid values: AccessInternetIpV4: all types of Alibaba Cloud public IPv4 addresses. AccessInternetIpV4Limited: all types of Alibaba Cloud public IPv4 addresses that are subject to region-specific speed limits. ElasticIP: elastic IP addresses (EIPs) (IPv4). PublicIpEcs: fixed public IP addresses (IPv4) that are attached to ECS instances. PublicIpClb: fixed public IP addresses (IPv4) that are attached to CLB instances. NAT: Internet traffic that passes through SNAT. TR: traffic that flows through a TransitRouter of a Cloud Enterprise Network (CEN) instance. TRAttachment: traffic that flows through a CEN connection instance, including intra-region connections and inter-region connections. VBR: traffic that flows through a virtual border router. GA: traffic that flows through a Global Accelerator (GA) instance. InternetProbing: data about Internet probe quality. IntranetProbing: data about internal network probe quality.	AccessInternetIpV4
Direction	string	Yes	The direction of network traffic on the Alibaba Cloud resource. Valid values: in: the inbound traffic direction. out: the outbound traffic direction. Important Cross-domain traffic analysis collects only outbound traffic. Therefore, if you set this parameter to in, the value is automatically changed to out. For intra-region and inter-region performance monitoring, you must specify the source or destination in the Filter parameter. Therefore, the Direction parameter is invalid.	in
GroupBy	string	Yes	The dimension for ranking metrics. The valid values vary based on the scenario. Rankings of full stream data: Tuple1: a 1-tuple that provides rankings of full stream data at the cloud IP address granularity. Tuple2: a 2-tuple that provides rankings of full stream data at the source and destination IP address granularity. Tuple5: a 5-tuple that provides rankings of full stream data at the granularity of source and destination IP addresses, ports, and protocols. Rankings of traffic statistics: Protocol: aggregates traffic by protocol type. SourcePort: aggregates traffic by source port. DestinationPort: aggregates traffic by destination port. InstanceId: aggregates traffic by cloud resource ID. IpPair: aggregates traffic by source and destination IP address pair. Country: aggregates traffic by client country. Province: aggregates traffic by client province. City: aggregates traffic by client city. ISP: aggregates traffic by client ISP. ASN: aggregates traffic by client ISP autonomous system number (ASN). CityASN: aggregates traffic by client city and ISP ASN. RegionPair: aggregates traffic for cross-region access over CEN. Rankings of network access performance: CountryIsp: ranks the performance of Internet access from a specified region to different countries and ISPs. Province: ranks the performance of access from a specified region to different provinces in China. ProvinceIsp: ranks the performance of access from a specified region to different provinces and ISPs in China. RegionPair: ranks the performance of cross-region access between Alibaba Cloud regions. ZonePair: ranks the performance of access between zones in a specified region.	Protocol
OrderBy	string	Yes	The metric used to rank Internet traffic. This parameter is case-sensitive. Valid values: bps: bits per second. pps: packets per second. ByteCount: the total number of bytes. PacketCount: the total number of packets. rtt: the RT when a TCP connection is established. RetransmitRate: the retransmission rate. RatelimitDropPps: the rate of packet loss due to speed limiting. ActiveSessionCount: the number of concurrent sessions. NewSessionPerSecond: the number of new sessions per second.	bps
Filter	array<object>	No	Specifies additional filter conditions to focus the network traffic analysis.
	object	No	A list of filter conditions for querying resources.
Name	string	No	The name of the filter condition.	instanceId
Value	string	No	The value of the filter condition.	lb-2zxxxxz1d
BeginTime	integer	No	The beginning of the time range to query. This is a UNIX timestamp. Unit: ms. If you do not specify this parameter, data from the last hour is queried.	1684373600099
EndTime	integer	No	The end of the time range to query. This is a UNIX timestamp. Unit: ms. If you do not specify this parameter, data from the last hour is queried. If you specify only BeginTime, data within 1 hour after the specified BeginTime is queried.	1684379093000
Sort	string	No	The sorting order. The default value is desc. Valid values: asc: ascending order. desc: descending order.	desc
TopN	integer	No	The number of entries to return. Default value: 10. This indicates that the top 10 entries are returned. Maximum value: 100.	10
UseCrossAccount	boolean	No	Specifies whether to use the multi-account access mode. This is a reserved parameter and is not supported.	false
AccountIds	array	No	The IDs of the member accounts.
	string	No	A list of member account IDs.	118639953821****

Response elements

Element	Type	Description	Example
	object	RpcResponse<ArrayList>
RequestId	string	The request ID.	A7F0D6EC-E19E-58AC-AC9F-08036763960F
Data	array<object>	A collection of cloud network metric ranking data.
	object	A row of cloud network metric ranking data.
RegionNo	string	The ID of the Alibaba Cloud region.	cn-shenzhen
InstanceId	string	The ID of the cloud resource instance. In a cross-domain traffic analysis scenario, this parameter indicates the CEN ID. In an Internet scenario, this parameter indicates the EIP ID, ECS ID, or CLB ID.	eip-sample*
BandwidthPackageId	string	The ID of the bandwidth plan instance.	cbwp-sample*
SourceIp	string	The source IP address.	42.120.XX.XX
SourcePort	string	The source port.	443
SourceIsp	string	The source ISP.	China Mobile
DestinationIp	string	The destination IP address.	2.2.XX.XX
DestinationPort	string	The destination port.	80
DestinationIsp	string	The destination ISP.	Alibaba Cloud
Protocol	string	The network protocol.	6
Country	string	The country where the client is located.	China
Province	string	The province or state where the client is located.	Sichuan Province
City	string	The city where the client is located.	Chengdu
Isp	string	The client ISP.	China Mobile
Asn	string	The ASN of the client ISP.	129103
IP	string	The IP address.	120.238.XX.XX
DestinationRegionNo	string	The ID of the destination region.	cn-hangzhou
VbrId	string	The ID of the virtual border router instance.	vbr-sample*
AttachmentId	string	The ID of the transit router connection.	tr-sample*
SourceZone	string	The source zone of the probe.	cn-hangzhou-a
DestinationZone	string	The destination zone of the probe.	cn-hangzhou-b
ByteCount	number	The traffic volume in bytes.	1024
PacketCount	number	The number of packets.	66
RTT	number	The latency. Unit: ms.	23
RetransmitRate	number	The retransmission rate of TCP messages.	0.1
InBps	number	The inbound bandwidth. Unit: bps.	10
InPps	number	The inbound packet rate. Unit: packets/second.	3
OutBps	number	The outbound bandwidth. Unit: bps.	88
OutPps	number	The outbound packet rate. Unit: packets/second.	8
NewSessionPerSecond	number	The number of new connections. Unit: connections/second.	18
ActiveSessionCount	number	The number of concurrent connections. Unit: connections.	66

Examples

Success response

JSON format

{
  "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
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.BeginTimeAndEndTime	It only supports querying data for up to 24 hours: %s.	The time range that you can query must be no longer than 24 hours.
400	OperationFailed.DataTooMuch	Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.	Too much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.
400	IllegalParam.OrderBy	The specified param of orderBy (%s) is invalid.	The specified sort field (%s) is invalid.
400	IllegalParam.ResourceType	The specified resourceType (%s) is invalid.	The value of ResourceType is invalid.
400	IllegalParam.GroupBy	The specified param of GroupBy (%s) is invalid.	The specified group field (%s) is invalid.
400	IllegalParam.Direction	The specified direction (%s) is invalid.	The Direction parameter is invalid. Modify the parameter and try again.
400	IllegalParam.Filter.InstanceId	The specified InstanceId(%s) is illegal.
400	IllegalParam.BeginTimeAndEndTime5M	It only supports querying data for up to 5 minute when TupleType is 5 and the CloudIp and OtherIp are both empty: %s.	When TupleType = 5 and the CloudIp and OtherIp are both empty, you can only query data in a range of up to 5 minutes.
400	IllegalParam.ServiceOffline	The service has been taken offline.	The service has been taken offline.
404	ResourceNotFound.InstanceId	The specified InstanceId(%s) does not exist.	The specified InstanceId does not exist.
404	ResourceNotFound.IpSets	The specified instance does not exist or does not have any acceleration region.	The specified instance does not exist or does not have any acceleration region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.