全部产品
Search
文档中心

网络智能服务:GetInternetTuple - 获取公网流量详情数据排名

更新时间:Sep 13, 2024
目前该API接口已标记为弃用,推荐使用替代API:nis(2021-12-16) - GetNisNetworkRanking

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

调试

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

授权信息

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

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

请求参数

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

要查询的公网流量的地域 ID。

cn-shanghai
TupleTypeinteger

查询的元组类型。取值:

  • 1:表示一元组。
  • 2:表示二元组。
  • 5:表示五元组。
1
BeginTimelong

查询起始时间的毫秒时间戳。

1684373600099
EndTimelong

查询结束时间的毫秒时间戳。

1684373700099
Directionstring

查询流量方向,取值:

  • in:入云方向。
  • out:出云方向。
in
OrderBystring

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

ByteCount
CloudIpstring

阿里云端 IP。

112.74.XX.XX
CloudPortstring

阿里云端端口。

说明 TupleType 配置为 5 时,才需要配置该参数。
443
OtherIpstring

对端 IP。

说明 TupleType 配置为 25 时,才需要配置该参数。
122.112.XX.XX
OtherPortstring

对端端口。

说明 TupleType 配置为 5 时,才需要配置该参数。
40002
InstanceIdstring

阿里云端实例 ID。

eip-sample*
Protocolstring

协议号。

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

流量数据的排序方式。

  • desc:从大到小排序。
  • asc:从小到大排序
desc
TopNinteger

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

10
CloudIspstring

云端运营商。

说明 通常为“阿里巴巴”或“阿里云”。
阿里巴巴
OtherIspstring

对端运营商。

说明 查看运营商情况时,请指定此参数。
移动
OtherCountrystring

对端国家。

说明 TupleType 配置为 25 时,才需要配置该参数。
中国
OtherCitystring

对端城市。

说明 TupleType 配置为 25 时,才需要配置该参数。
杭州市
InstanceListarray

批量过滤时的实例 ID 列表。

string

批量过滤时的实例 ID。

[\"eip-sample*\"]
CloudIpListarray

批量过滤时的云上 IP 列表。

string

批量过滤时的云上 IP。

[\"103.212.XX.XX\"]
UseMultiAccountboolean

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

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

成员账号 ID 列表。

long

某个成员账号 ID。

[123]

返回参数

名称类型描述示例值
object

RpcResponse<ArrayList>

RequestIdstring

请求 ID。

D5E98683-355B-5867-8D3D-A24755F6895B
Dataarray<object>

公网流量详情排名列表。

object

公网流量单行详情。

BeginTimestring

数据毫秒时间戳。

1684373600099
Directionstring

流量方向。取值:

  • in:入云方向。
  • out:出云方向。
in
InstanceIdstring

阿里云端 IP 归属的实例 ID。

eip-sample*
AccessRegionstring

流量进入阿里云的接入点。

说明 InstanceId 为 Anycast 弹性公网 IP 时,该参数有效。
cn-hongkong-pop
CloudIpstring

阿里云端 IP。

112.74.XX.XX
CloudPortstring

阿里云端端口。

443
OtherIpstring

对端 IP。

122.112.XX.XX
OtherPortstring

对端端口。

40002
Protocolstring

协议号。

6
CloudCountrystring

阿里云端国家或地区。

中国
CloudProvincestring

阿里云端省份。

江苏省
CloudCitystring

阿里云端城市。

南京市
CloudIspstring

阿里云端运营商。

移动
CloudProductstring

阿里云侧 IP 归属的实例对应的产品 Code。

EIP
OtherCountrystring

对端国家或地区。

美国
OtherProvincestring

对端省份。当 OtherCountry 为国外时,此值多数为空。

得克萨斯州
OtherCitystring

对端城市。当 OtherCountry 为国外时,此值多数为空。

奥斯汀
OtherIspstring

对端运营商。

amazon.com
OtherProductstring

对端 IP 归属的产品。如果非云上 IP,则为空。

ECS
Rttdouble

往返时延 RTT(Round Trip Time)。单位:us。

10000
ByteCountdouble

流量数(Byte)。

88
PacketCountdouble

流量包数。

66
OutOrderCountdouble

乱序包数。

1
InByteCountdouble

入云方向流量数。单位:Byte。

88
OutByteCountdouble

出云方向流量数。单位:Byte。

66
InPacketCountdouble

入云方向流量包数。

33
OutPacketCountdouble

出云方向流量包数。

22
InOutOrderCountdouble

入云方向乱序包数。

2
OutOutOrderCountdouble

出云方向乱序包数。

1
InRetranCountdouble

入云方向重传包数。

0
OutRetranCountdouble

出云方向重传包数。

1
RetransmitRatedouble

TCP 报文的重传率。

0.1

示例

正常返回示例

JSON格式

{
  "RequestId": "D5E98683-355B-5867-8D3D-A24755F6895B",
  "Data": [
    {
      "BeginTime": "1684373600099",
      "Direction": "in",
      "InstanceId": "eip-sample*",
      "AccessRegion": "cn-hongkong-pop",
      "CloudIp": "112.74.XX.XX",
      "CloudPort": "443",
      "OtherIp": "122.112.XX.XX",
      "OtherPort": "40002",
      "Protocol": "6",
      "CloudCountry": "中国",
      "CloudProvince": "江苏省",
      "CloudCity": "南京市",
      "CloudIsp": "移动",
      "CloudProduct": "EIP",
      "OtherCountry": "美国",
      "OtherProvince": "得克萨斯州",
      "OtherCity": "奥斯汀",
      "OtherIsp": "amazon.com",
      "OtherProduct": "ECS",
      "Rtt": 10000,
      "ByteCount": 88,
      "PacketCount": 66,
      "OutOrderCount": 1,
      "InByteCount": 88,
      "OutByteCount": 66,
      "InPacketCount": 33,
      "OutPacketCount": 22,
      "InOutOrderCount": 2,
      "OutOutOrderCount": 1,
      "InRetranCount": 0,
      "OutRetranCount": 1,
      "RetransmitRate": 0.1
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.TopNThe TopN(%s) should not greater than 100.最大仅支持Top 100,实际传入为(%s)。
400IllegalParam.BeginTimeAndEndTime1HIt only supports querying data for up to 1 hour: %s.最长支持查询1小时数据: %s。
400IllegalParam.GroupByThe specified param of GroupBy (%s) is invalid.指定的分组字段(%s)不合法。
400IllegalParam.OrderByThe specified param of orderBy (%s) is invalid.指定的排序字段(%s)不合法。
400IllegalParam.RegionIdThe specified region ID (%s) is invalid.指定的地域(%s)不合法。
400IllegalParam.BeginTimeAndEndTimeIt only supports querying data for up to 24 hours: %s.最大支持查询24小时数据。
400IllegalParam.BeginTimeAndEndTime5MIt only supports querying data for up to 5 minute when TupleType is 5 and the CloudIp and OtherIp are both empty: %s.当TupleType=5且CloudIp、OtherIp都是空时,只支持查询最长5分钟范围的数据。
400OperationFailed.DbConcurrentTooHighThe operation failed due to too many concurrent queries. Please try again later.当前用户过多,导致操作失败,请稍后再重试。
400OperationFailed.DataTooMuchToo much data has been queried under the specified conditions. Shorten the query time, specify more precise filtering conditions, or try again later.指定条件下查询的数据过多,请缩短查询时间、指定更精确过滤条件或者稍后重试。
404ResourceNotFound.InstanceIdThe specified InstanceId(%s) does not exist.指定的InstanceId(%s)不存在。
404ResourceNotFound.IpSetsThe specified instance does not exist or does not have any acceleration region.指定的实例不存在或者没有加速区域。

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

变更历史

变更时间变更内容概要操作
2024-07-10OpenAPI 变更为 deprecated,即将下线、OpenAPI 错误码发生变更查看变更详情
2024-06-17OpenAPI 错误码发生变更查看变更详情
2024-04-15OpenAPI 错误码发生变更查看变更详情
2024-04-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-01-19OpenAPI 错误码发生变更查看变更详情
2024-01-11OpenAPI 错误码发生变更查看变更详情
2023-12-07OpenAPI 错误码发生变更查看变更详情
2023-11-24OpenAPI 错误码发生变更查看变更详情
2023-11-17OpenAPI 错误码发生变更查看变更详情
2023-11-16OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-06-19OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情