目前该API接口已标记为弃用,推荐使用替代API:nis(2021-12-16) - GetNisNetworkRanking。
调用GetVbrFlowTopN接口,获取混合云流量详情数据排名,覆盖一元组、二元组、五元组粒度,支持按流量、包数等指标排序。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
nis:GetVbrFlowTopN | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 云端地域。 | cn-shanghai |
BeginTime | long | 是 | 查询起始时间的毫秒时间戳。最大支持查 24 小时跨度的数据。 | 1638239092000 |
EndTime | long | 是 | 查询结束时间的毫秒时间戳。最大支持查 24 小时跨度的数据。 | 1638239093000 |
Direction | string | 是 | 对于当前地域或 IP 的流量方向。
| in |
GroupBy | string | 是 | 指定混合云流量排名的维度,大小写敏感,注意区分大小写。取值:
| 1Tuple |
OrderBy | string | 否 | 数据排序的指标。默认值:Bytes,表示按流量排序。 | Bytes |
Sort | string | 否 | 排序方式。取值:
| desc |
TopN | integer | 否 | 展示排序靠前的数据。默认值:10。表示默认展示排序前 10 的数据。最大 100。 | 10 |
CenId | string | 否 | CEN 实例 ID。 | cen-ia8kw1zjv4hyal**** |
VirtualBorderRouterId | string | 否 | 专线 VBR 实例 ID。 | vbr-k1atj46citwuek42j**** |
AttachmentId | string | 否 | CEN 的连接 ID。 | tr-attach-dnv870gmqzmb5u**** |
Protocol | string | 否 | 协议号。 说明
支持全部协议,仅 GroupBy 配置为 5Tuple 或 Protocol 时,才需要配置该参数。
| 6 |
CloudIp | string | 否 | 云端 IP。 | 112.74.XX.XX |
OtherIp | string | 否 | IDC 侧 IP。 | 122.112.XX.XX |
CloudPort | string | 否 | 云端端口号。 说明
仅 GroupBy 配置为 CloudPort 时,才需要配置该参数。
| 443 |
OtherPort | string | 否 | IDC 侧端口号。 说明
仅 GroupBy 配置为 OtherPort 时,才需要配置该参数。
| 40002 |
AccountIds | array | 否 | 成员账号 ID 列表。 | |
long | 否 | 某个成员账号 ID。 | [\"118639953821****\"] | |
UseMultiAccount | boolean | 否 | 是否使用多账号管理功能。默认值:false。表示不使用。 说明
多账号管理功能默认不开放,如需使用,请联系商务经理申请使用权限。
| false |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalParam.TopN | The TopN(%s) should not greater than 100. | 最大仅支持Top 100,实际传入为(%s)。 |
400 | IllegalParam.BeginTime | The specified begin time (%s) is invalid. | 指定的开始时间(%s)不合法。 |
400 | IllegalParam.BeginTimeAndEndTime | It only supports querying data for up to 7 days: %s. | 最大仅支持查询7天的数据:%s。 |
400 | IllegalParam.Sort | The specified Sort(%s) is invalid. | 排序字段必须为('desc','asc')其中之一 |
400 | IllegalParam.OrderBy | The specified param of orderBy (%s) is invalid. | 指定的排序字段(%s)不合法。 |
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. | 指定条件下查询的数据过多,请缩短查询时间、指定更精确过滤条件或者稍后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-10 | OpenAPI 变更为 deprecated,即将下线、OpenAPI 错误码发生变更 | 查看变更详情 |
2024-03-06 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-12-07 | OpenAPI 错误码发生变更 | 查看变更详情 |