文档

GetVbrFlowTopN - 获取混合云流量详情数据排名

更新时间:

调用GetVbrFlowTopN接口,获取混合云流量详情数据排名,覆盖一元组、二元组、五元组粒度,支持按流量、包数等指标排序。

调试

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

授权信息

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

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

请求参数

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

云端地域。

cn-shanghai
BeginTimelong

查询起始时间的毫秒时间戳。最大支持查 24 小时跨度的数据。

1638239092000
EndTimelong

查询结束时间的毫秒时间戳。最大支持查 24 小时跨度的数据。

1638239093000
Directionstring

对于当前地域或 IP 的流量方向。

  • in:从 IDC 访问阿里云。
  • out:从阿里云访问 IDC。
in
GroupBystring

指定混合云流量排名的维度,大小写敏感,注意区分大小写。取值:

  • 1Tuple:查询混合云流量中云企业网 CEN(Cloud Enterprise Network)、连接、改为边界路由器 VBR(Virtual Border Router)、IP 维度的排名。
  • 2Tuple:查询混合云流量中两端 IP 维度的排名。
  • 5Tuple:查询混合云流量中两端 IP、两端端口和协议维度的排名。
  • CloudPort:查询混合云流量中云端端口的排名。
  • OtherPort:查询混合云流量中 IDC 端端口的排名。
  • Protocol:查询混合云流量中协议维度的排名。
1Tuple
OrderBystring

数据排序的指标。默认值:Bytes,表示按流量排序。

Bytes
Sortstring

排序方式。取值:

  • desc:降序。
  • asc:升序。
desc
TopNinteger

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

10
CenIdstring

CEN 实例 ID。

cen-ia8kw1zjv4hyal****
VirtualBorderRouterIdstring

专线 VBR 实例 ID。

vbr-k1atj46citwuek42j****
AttachmentIdstring

CEN 的连接 ID。

tr-attach-dnv870gmqzmb5u****
Protocolstring

协议号。

说明 支持全部协议,仅 GroupBy 配置为 5TupleProtocol 时,才需要配置该参数。
6
CloudIpstring

云端 IP。

112.74.XX.XX
OtherIpstring

IDC 侧 IP。

122.112.XX.XX
CloudPortstring

云端端口号。

说明 GroupBy 配置为 CloudPort 时,才需要配置该参数。
443
OtherPortstring

IDC 侧端口号。

说明 GroupBy 配置为 OtherPort 时,才需要配置该参数。
40002
AccountIdsarray

成员账号 ID 列表。

long

某个成员账号 ID。

[\"118639953821****\"]
UseMultiAccountboolean

是否使用多账号管理功能。默认值:false。表示不使用。

说明 多账号管理功能默认不开放,如需使用,请联系商务经理申请使用权限。
false

返回参数

名称类型描述示例值
object

RpcResponse

RequestIdstring

请求 ID。

A7F0D6EC-E19E-58AC-AC9F-08036763960F
VirtualBorderRouterFlowlogTopNobject []

混合云流量详情排名列表。

CloudRegionstring

云端 IP 对应的云端地域。

cn-shanghai
CloudIpstring

云端 IP。

120.24.X.X
OtherIpstring

IDC 侧 IP。

222.85.X.X
CloudPortstring

云端端口。

80
OtherPortstring

IDC 侧端口。

10965
Protocolstring

协议号。

6
AttachmentIdstring

CEN 的连接 ID。

tr-attach-u6v1j3jre0fe9h****
VirtualBorderRouterIdstring

专线 ID。

vbr-k1atj46citwuek42j****
Bytesdouble

指定时间段内的流量总和。

108
Packetsdouble

指定时间段内的发包数总和。

66
AccountIdstring

账号 ID。

156237031628****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400IllegalParam.TopNThe TopN(%s) should not greater than 100.最大仅支持Top 100,实际传入为(%s)。
400IllegalParam.BeginTimeThe specified begin time (%s) is invalid.指定的开始时间(%s)不合法。
400IllegalParam.BeginTimeAndEndTimeIt only supports querying data for up to 7 days: %s.最大仅支持查询7天的数据:%s。
400IllegalParam.SortThe specified Sort(%s) is invalid.排序字段必须为('desc','asc')其中之一
400IllegalParam.OrderByThe specified param of orderBy (%s) is invalid.指定的排序字段(%s)不合法。
400OperationFailed.DataTooMuchToo much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.指定条件下查询的数据过多,请缩短查询时间、指定更精确过滤条件或者稍后重试。

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

变更历史

变更时间变更内容概要操作
2024-03-06OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-12-07OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
  • 本页导读 (1)