Queries the rankings of hybrid cloud traffic data in the form of 1-tuple, 2-tuple, or 5-tuple. Hybrid cloud traffic data can be ranked by metrics such as traffic volumes and the number of packets.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| nis:GetVbrFlowTopN | list |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The local region. | cn-shanghai |
| BeginTime | long | Yes | The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. The maximum time range that you can query is 24 hours. | 1638239092000 |
| EndTime | long | Yes | The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. The maximum time range that you can query is 24 hours. | 1638239093000 |
| Direction | string | Yes | The direction of the hybrid cloud traffic in the local regions or for the local IP addresses. Valid values:
| in |
| GroupBy | string | Yes | The dimension for ranking hybrid cloud traffic data. The value of this parameter is case-sensitive. Valid values:
| 1Tuple |
| OrderBy | string | No | The metric for ranking hybrid cloud traffic data. Default value: Bytes. This value specifies that hybrid cloud traffic data is ranked by traffic volumes. | Bytes |
| Sort | string | No | The order for ranking hybrid cloud traffic data. Valid values:
| desc |
| TopN | integer | No | Specifies top-N traffic data to display. Default value: 10. This value specifies that top-10 traffic data is displayed by default. Maximum value: 100. | 10 |
| CenId | string | No | The CEN instance ID. | cen-ia8kw1zjv4hyal**** |
| VirtualBorderRouterId | string | No | The ID of the VBR that is associated with 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 if you set GroupBy to 5Tuple or Protocol.
| 6 |
| CloudIp | string | No | The local IP address. | 112.74.XX.XX |
| OtherIp | string | No | The remote IP address. | 122.112.XX.XX |
| CloudPort | string | No | The local port. Note
This parameter is required only if you set GroupBy to CloudPort.
| 443 |
| OtherPort | string | No | The remote port. Note
This parameter is required only if you set GroupBy to OtherPort.
| 40002 |
| AccountIds | array | No | The IDs of member accounts. | |
| string | No | The ID of the member account. | [\"118639953821****\"] | |
| UseMultiAccount | boolean | No | Specifies whether to enable the multi-account management feature. Default value: false. This value specifies that the multi-account management feature is disabled. Note
By default, the multi-account management feature is not available. If you want to use this feature, contact your account manager to apply for permissions.
| false |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
"VirtualBorderRouterFlowlogTopN": [
{
"CloudRegion": "cn-shanghai",
"CloudIp": "120.24.X.X",
"OtherIp": "222.85.X.X",
"CloudPort": "80",
"OtherPort": "10965",
"Protocol": "6",
"AttachmentId": "tr-attach-u6v1j3jre0fe9h****",
"VirtualBorderRouterId": "vbr-k1atj46citwuek42j****",
"Bytes": 108,
"Packets": 66,
"AccountId": "156237031628****"
}
]
}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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-07-10 | The API operation is deprecated. The Error code has changed | View Change Details |
| 2024-03-06 | The Error code has changed | View Change Details |
| 2023-12-07 | The Error code has changed | View Change Details |