文档

GetTransitRouterFlowTopN - 获取跨域流量详情数据排名

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

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

1684373600099
EndTimelong

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

1638239093000
TopNinteger

取最大多少条数据。默认值:10。最大值:100

20
Directionstring

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

  • in:入流量。
  • out:出流量。
in
GroupBystring

指定跨域流量排名的维度,大小写敏感,请注意区分大小写。取值:

  • 1Tuple:查询跨域流量中当前地域、云企业网 CEN(Cloud Enterprise Network)、IP 维度的排名。
  • 2Tuple:查询跨域流量中两端地域、两端 IP 维度的排名。
  • 5Tuple:查询跨域流量中两端 IP、两端端口和协议维度的排名。
  • Cen:查询跨域流量中云企业网 CEN 实例维度的排名。
  • RegionPair:查询跨域流量中两端地域维度的排名。
  • Port:查询跨域流量中端口维度的排名。
  • Protocol:查询跨域流量中协议维度的排名。
1Tuple
ThisRegionstring

当前地域,即 ThisIp 所在地域。

cn-shanghai
ThisIpstring

本端 IP 地址。

1.8.XX.XX
ThisPortstring

本端端口。

80
OtherRegionstring

对端地域。

ap-southeast-1
OtherIpstring

对端 IP 地址。

122.112.XX.XX
OtherPortstring

对端端口。

10869
Protocolstring

协议号。

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

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

Bytes
Sortstring

流量数据的排序方式。

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

CEN 实例 ID。

cen-ia8kw1zjv4hyal****
BandwithPackageIdstring

CEN 带宽包 ID。

cenbwp-ia8kw1zjv4hyal****
AccountIdsarray

成员账号 ID 列表。

long

某个成员账号 ID。

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

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

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

返回参数

名称类型描述示例值
object

RpcResponse

RequestIdstring

请求 ID。

D5E98683-355B-5867-8D3D-A24755F6895B
TransitRouterFlowTopNobject []

跨域流量详情排名列表。

AccountIdstring

账号 ID。

118639953821****
CenIdstring

CEN 实例 ID。

cen-ia8kw1zjv4hyal****
ThisRegionstring

本端地域,即 ThisIp 所在地域。

cn-shanghai
ThisIpstring

本端 IP 地址。

1.8.XX.XX
ThisPortstring

本端端口号。

80
OtherRegionstring

目的地域,即 OtherIp 所在地域。

ap-southeast-1
OtherIpstring

对端 IP 地址。

47.216.XX.XX
OtherPortstring

对端端口号。

53470
Protocolstring

协议号。

6
StartTimestring

开始时间。

2023-01-31T05:40:00Z
EndTimestring

结束时间。

2023-01-31T06:40:00Z
Packetsdouble

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

88
Bytesdouble

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

188
BandwithPackageIdstring

CEN 带宽包 ID。

cenbwp-ia8kw1zjv4hyal****

示例

正常返回示例

JSON格式

{
  "RequestId": "D5E98683-355B-5867-8D3D-A24755F6895B",
  "TransitRouterFlowTopN": [
    {
      "AccountId": "118639953821****",
      "CenId": "cen-ia8kw1zjv4hyal****",
      "ThisRegion": "cn-shanghai",
      "ThisIp": "1.8.XX.XX",
      "ThisPort": "80",
      "OtherRegion": "ap-southeast-1",
      "OtherIp": "47.216.XX.XX",
      "OtherPort": "53470",
      "Protocol": "6",
      "StartTime": "2023-01-31T05:40:00Z",
      "EndTime": "2023-01-31T06:40:00Z",
      "Packets": 88,
      "Bytes": 188,
      "BandwithPackageId": "cenbwp-ia8kw1zjv4hyal****"
    }
  ]
}

错误码

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.OrderByThe specified param of orderBy (%s) is invalid.指定的排序字段(%s)不合法。
400IllegalParam.SortThe specified Sort(%s) is invalid.排序字段必须为('desc','asc')其中之一
400IllegalParam.AccountIdsThe specified parameter accountId (%s) is invalid.指定的AccountId (%s)不在用户可选范围内。
400IllegalParam.inOrOutValid values for the inOrOut parameter: in and out.参数inOrOut必须为i('in','out')之一。

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

变更历史

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