GetVbrFlowTopN-阿里云帮助中心

Retrieves the ranking of hybrid cloud traffic details, covering 1-tuple, 2-tuple, and 5-tuple granularities, and supports sorting by metrics such as traffic and packet count.

Note

This API has been deprecated. We recommend migrating to nis(2021-12-16) - GetNisNetworkRanking for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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:GetVbrFlowTopN

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The cloud region.	cn-shanghai
BeginTime	integer	Yes	The start time of the query, in milliseconds (UNIX timestamp). The maximum query span is 24 hours.	1638239092000
EndTime	integer	Yes	The end time of the query, in milliseconds (UNIX timestamp). The maximum query span is 24 hours.	1638239093000
Direction	string	Yes	The traffic direction relative to the current region or IP address. Valid values: in: From IDC to Alibaba Cloud. out: From Alibaba Cloud to IDC.	in
GroupBy	string	Yes	The dimension for hybrid cloud traffic ranking. This parameter is case-sensitive. Valid values: 1Tuple: Ranks hybrid cloud traffic by Cloud Enterprise Network (CEN), connection, Virtual Border Router (VBR), and IP dimensions. 2Tuple: Ranks hybrid cloud traffic by source and destination IP dimensions. 5Tuple: Ranks hybrid cloud traffic by source and destination IPs, source and destination ports, and protocol dimensions. CloudPort: Ranks hybrid cloud traffic by cloud-side port. OtherPort: Ranks hybrid cloud traffic by IDC-side port. Protocol: Ranks hybrid cloud traffic by protocol.	1Tuple
OrderBy	string	No	The metric used for sorting. Default value: Bytes, which sorts by traffic volume.	Bytes
Sort	string	No	The sort order. Valid values: desc: Descending. asc: Ascending.	desc
TopN	integer	No	The maximum number of top-ranked entries to return. Default value: 10, which returns the top 10 entries. Maximum value: 100.	10
CenId	string	No	The CEN instance ID.	cen-ia8kw1zjv4hyal****
VirtualBorderRouterId	string	No	The VBR instance ID of the Express Connect circuit.	vbr-k1atj46citwuek42j****
AttachmentId	string	No	The CEN connection ID.	tr-attach-dnv870gmqzmb5u****
Protocol	string	No	The protocol number. Note All protocols are supported. This parameter is required only when GroupBy is set to 5Tuple or Protocol.	6
CloudIp	string	No	The cloud-side IP address.	112.74.XX.XX
OtherIp	string	No	The IDC-side IP address.	122.112.XX.XX
CloudPort	string	No	The cloud-side port number. Note This parameter is required only when GroupBy is set to CloudPort.	443
OtherPort	string	No	The IDC-side port number. Note This parameter is required only when GroupBy is set to OtherPort.	40002
AccountIds	array	No	The list of member account IDs.
	integer	No	The ID of a member account.	[\"118639953821****\"]
UseMultiAccount	boolean	No	Specifies whether to enable the multi-account management feature. Default value: false, which indicates that this feature is disabled. Note The multi-account management feature is not available by default. To use this feature, contact your account manager to request access.	false

Response elements

Element	Type	Description	Example
	object	RpcResponse
RequestId	string	The request ID.	A7F0D6EC-E19E-58AC-AC9F-08036763960F
VirtualBorderRouterFlowlogTopN	array<object>	The ranking list of hybrid cloud traffic details.
	object	The hybrid cloud traffic details.
AccountId	string	The account ID.	156237031628****
AttachmentId	string	The CEN connection ID.	tr-attach-u6v1j3jre0fe9h****
Bytes	number	The total traffic volume within the specified time range.	108
CloudIp	string	The cloud-side IP address.	120.24.X.X
CloudPort	string	The cloud-side port.	80
CloudRegion	string	The cloud region that corresponds to the cloud-side IP address.	cn-shanghai
OtherIp	string	The IDC-side IP address.	222.85.X.X
OtherPort	string	The IDC-side port.	10965
Packets	number	The total number of packets within the specified time range.	66
Protocol	string	The protocol number.	6
VirtualBorderRouterId	string	The VBR instance ID.	vbr-k1atj46citwuek42j****

Examples

Success response

JSON format

{
  "RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
  "VirtualBorderRouterFlowlogTopN": [
    {
      "AccountId": "156237031628****",
      "AttachmentId": "tr-attach-u6v1j3jre0fe9h****",
      "Bytes": 108,
      "CloudIp": "120.24.X.X",
      "CloudPort": "80",
      "CloudRegion": "cn-shanghai",
      "OtherIp": "222.85.X.X",
      "OtherPort": "10965",
      "Packets": 66,
      "Protocol": "6",
      "VirtualBorderRouterId": "vbr-k1atj46citwuek42j****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.TopN	The TopN(%s) should not greater than 100.	Only top 100 are supported. Actual input: (%s).
400	IllegalParam.BeginTime	The specified begin time (%s) is invalid.	The specified start time (%s) is invalid.
400	IllegalParam.BeginTimeAndEndTime	It only supports querying data for up to 7 days: %s.	You can query data within the last seven days: %s.
400	IllegalParam.Sort	The specified Sort(%s) is invalid.	Valid values for the sort field: desc and asc.
400	IllegalParam.OrderBy	The specified param of orderBy (%s) is invalid.	The specified sort field (%s) is invalid.
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.RegionId	The specified region ID (%s) is invalid.	The specified region ID (%s) is invalid.
400	QuotaExceeded.CheckRowReadLimit	The query time range (%s) exceeds the number of data rows limit. Shorten the query interval.	The query time range (%s) exceeds the number of data rows limit. Shorten the query interval.
400	IllegalParam.GroupBy	The specified param of GroupBy (%s) is invalid.	The specified group field (%s) is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.