触发NIS流量分析器执行指定范围内的流量排序任务。
接口说明
请确保在使用该接口前,已充分了解 NIS-流量分析器的收费方式和价格。
使用该接口前,您需要先完成流量分析器创建和数据源添加。
支持分析场景:
全部 VPC 流日志分析
公网 VPC 流日志分析
全部 TR 流日志分析
共享带宽指标分析
全部 VPC 流日志分析
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |
| RegionNo | string | 是 | 资源所在地域。 | cn-shanghai | - |
| TrafficAnalyzerId | string | 是 | 流量分析器 ID。 | nta-262****ca07f | - |
| TrafficScenario | string | 是 | 支持分析场景: ● 全部 VPC 流日志分析 | 固定为:VpcFlowLogAll | VpcFlowLogAll |
| Direction | string | 是 | 基于阿里云资源的网络流量方向。● In:流入 ENI 的流量。 ● Out:流出 ENI 的流量。 | In | - In - Out |
| TupleDimension | string | 是 | 流量存储聚合维度。 | Tuple1 | - Tuple1 - Tuple2 - Tuple5 |
| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | - | |
| string | 否 | 根据 TupleDimension 字段,可以指定流量的聚合维度如下: ● TupleDimension = Tuple1 时,支持: ■ VpcId:VPC ID ■ VSwitchId:交换机 ID ■ NetworkInterfaceId:弹性网卡 ID ■ EcsId:云服务器 ECS ID ■ CloudIp:云端 IP ● TupleDimension = Tuple2 时,支持: ■ VpcId:VPC ID ■ VSwitchId:交换机 ID ■ NetworkInterfaceId:弹性网卡 ID ■ EcsId:云服务器 ECS ID ■ SourceIp:源端 IP ■ DestinationIp:目的端 IP ■ TrafficPath:流量路径 ● TupleDimension = Tuple5 时,支持: ■ VpcId:VPC ID ■ VSwitchId:交换机 ID ■ NetworkInterfaceId:弹性网卡 ID ■ EcsId:云服务器 ECS ID ■ SourceIp:源端 IP ■ DestinationIp:目的端 IP ■ TrafficPath:流量路径 ■ SourcePort:源端端口 ■ DestinationPort:目的端口 ■ Protocol:网络协议 | ["VpcId"] | - VpcId - VSwitchId - CloudIp - SourceIp - DestinationIp - Protocol - SourcePort - DestinationPort - TrafficPath - Country - Province - City - Isp - Asn | |
| OrderBy | string | 是 | 根据 TrafficScenario 字段,支持按以下指标对流量进行排名: TrafficScenario = VpcFlowLogAll / VpcFlowLogInternet(VPC 流日志场景): ●Bytes:带宽 ● Packets:包数 ● RoundTripTime:TCP RTT | Bytes | - Bytes - Packets - RoundTripTime |
| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | - | |
| object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | - | ||
| key | string | 否 | 支持过滤的条件标签键,如下所示: - TupleDimension 为一元组时,支持:- FlowAction:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)- VpcId:VPC ID(对应 value 值可多选)- VSwitchId:交换机 ID(对应 value 值可多选)- NetworkInterfaceId:弹性网卡 ID(对应 value 值可多选)- EcsId:云服务器 ECS ID(对应 value 值可多选)- CloudIp:云端 IP(对应 value 值可多选)- TupleDimension 为二元组时,支持:- FlowAction:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)- VpcId:VPC ID(对应 value 值可多选)- VSwitchId:交换机 ID(对应 value 值可多选)- NetworkInterfaceId:弹性网卡 ID(对应 value 值可多选)- EcsId:云服务器 ECS ID(对应 value 值可多选)- SourceIp:源端 IP(对应 value 值可多选)- DestinationIp:目的端 IP(对应 value 值可多选)- TrafficPath:流量路径(对应 value 值可多选)- TupleDimension 为五元组时,支持:- FlowAction:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)- VpcId:VPC ID(对应 value 值可多选)- VSwitchId:交换机 ID(对应 value 值可多选)- NetworkInterfaceId:弹性网卡 ID(对应 value 值可多选)- EcsId:云服务器 ECS ID(对应 value 值可多选)- SourceIp:源端 IP- DestinationIp:目的端 IP- TrafficPath:流量路径(对应 value 值可多选)- SourcePort:源端口(对应 value 值可多选)- DestinationPort:目的端口(对应 value 值可多选)- Protocol:网络协议(对应 value 值可多选)- VPC 场景下,均可按流量指标过滤: - MinBytes:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)- MaxBytes:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)- MinRoundTripTime:指定参与排序的最小 RTT,单位 ms(对应 value 值不可多选)- MaxRoundTripTime:指定参与排序的最大 RTT,单位 ms(对应 value 值不可多选)- MinPackages:指定参与排序的最小包数,单位个(对应 value 值不可多选)- MaxPackages:指定参与排序的最大包数,单位个(对应 value 值不可多选) | FlowAction | - FlowAction - VpcId - VSwitchId - NetworkInterfaceId - CloudIp - DestinationIp - SourceIp - EcsId - TrafficPath - SourcePort - DestinationPort - Protocol - MinBytes - MaxBytes - MinRoundTripTime - MaxRoundTripTime - MinPackages - MaxPackages |
| value | array | 否 | 过滤条件的值。 | - | |
| string | 否 | 根据过滤的 key 类型,传入对应的过滤值。 当 key 为 FlowAction 时,value 枚举为:- ACCEPT(默认传 Accept):安全组和网络 ACL 允许的流量- REJECT:安全组和网络 ACL 拒绝的流量 | Accept | 当 key 为 FlowAction 时:ACCEPT / REJECT | |
| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in): ● in:等于 ● not in:不等于 ● like:包含 根据 TupleDimension 字段和 TrafficScenario 字段,like 的支持情况如下: TrafficScenario = VpcFlowLogAll / VpcFlowLogInternet(VPC 流日志场景): 当 key 为以下字段时,支持 like: ○ CloudIp ○ SourceIp ○ DestinationIp 除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in - in - like |
| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |
| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |
| Sort | string | 否 | 指定流量分析的排序方式: ● ASC:按正序排序。 ● DESC:按逆序排序。 | Desc | - Desc - Asc |
| TopN | integer | 否 | 指定流量排序查询的条目数。 支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |
| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN - en-US |
| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |
| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | |
| StorageInterval | integer | 否 | 存储桶精度属性。 存储桶精度用于查询指定的存储聚合周期。支持高精度(例如 1 分钟)或长周期(例如 1 天)2 种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。 - 流量分析器对应元组支持的存储精度为: - 1:单位分钟(1 分钟)- 10:单位分钟(10 分钟)- 60:单位分钟(60 分钟,即 1 小时)- 1440:单位分钟(1440 分钟,即 1 天)- 存储桶精度可用于两类典型用途: - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合 - 长周期流量统计:如 1440 分钟(1 天)聚合 - 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如: - 传入 10:查询短周期、以 10 分钟为聚合粒度的数据- 传入 1440:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1 - 10 - 60 - 1440 |
返回参数
| 名称 | 类型 | 描述 | 示例值 | 枚举值 |
| object | RpcResponse | - | ||
| RequestId | string | 请求 ID。 | 4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 | - |
| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |
公网 VPC 流日志分析
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |
| RegionNo | string | 是 | 资源所在地域。 | cn-shanghai | - |
| TrafficAnalyzerId | string | 是 | 流量分析器 ID。 | nta-262****ca07f | - |
| TrafficScenario | string | 是 | 支持分析场景: ● 公网 VPC 流日志分析 | 固定为:VpcFlowLogInternet | VpcFlowLogInternet |
| Direction | string | 是 | 基于阿里云资源的网络流量方向。● In:流入 ENI 的流量。 ● Out:流出 ENI 的流量。 | In | - In - Out |
| TupleDimension | string | 是 | 流量存储聚合维度。 | Tuple1 | - Tuple1 - Tuple2 - Tuple5 |
| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | - | |
| string | 否 | 根据 TupleDimension 字段,可以指定流量的聚合维度如下: ● TupleDimension = Tuple1 时,支持: ■ VpcId:VPC ID ■ VSwitchId:交换机 ID ■ NetworkInterfaceId:弹性网卡 ID ■ EcsId:云服务器 ECS ID ■ CloudIp:云端 IP ● TupleDimension = Tuple2 时,支持: ■ VpcId:VPC ID ■ VSwitchId:交换机 ID ■ NetworkInterfaceId:弹性网卡 ID ■ EcsId:云服务器 ECS ID ■ SourceIp:源端 IP ■ DestinationIp:目的端 IP ■ TrafficPath:流量路径 ■ Country:客户端国家■ Province:客户端省份■ City:客户端城市■ Isp:网络服务提供商■ Asn:自治系统号码● TupleDimension = Tuple5 时,支持: ■ VpcId:VPC ID ■ VSwitchId:交换机 ID ■ NetworkInterfaceId:弹性网卡 ID ■ EcsId:云服务器 ECS ID ■ SourceIp:源端 IP ■ DestinationIp:目的端 IP ■ TrafficPath:流量路径 ■ SourcePort:源端端口 ■ DestinationPort:目的端口 ■ Protocol:网络协议 ■ Country:客户端国家 ■ Province:客户端省份 ■ City:客户端城市 ■ Isp:网络服务提供商 ■ Asn:自治系统号码 | ["VpcId"] | - VpcId - VSwitchId - CloudIp - SourceIp - DestinationIp - Protocol - SourcePort - DestinationPort - TrafficPath - Country - Province - City - Isp - Asn | |
| OrderBy | string | 是 | 支持按以下指标对流量进行排名:Bytes、Packets、RoundTripTime | Bytes | - Bytes - Packets - RoundTripTime |
| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | - | |
| object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | - | ||
| key | string | 否 | 支持过滤的条件标签键,如下所示: - TupleDimension 为一元组时,支持:- FlowAction:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)- VpcId:VPC ID(对应 value 值可多选)- VSwitchId:交换机 ID(对应 value 值可多选)- NetworkInterfaceId:弹性网卡 ID(对应 value 值可多选)- EcsId:云服务器 ECS ID(对应 value 值可多选)- CloudIp:云端 IP(对应 value 值可多选)- TupleDimension 为二元组时,支持:- FlowAction:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)- VpcId:VPC ID(对应 value 值可多选)- VSwitchId:交换机 ID(对应 value 值可多选)- NetworkInterfaceId:弹性网卡 ID(对应 value 值可多选)- EcsId:云服务器 ECS ID(对应 value 值可多选)- SourceIp:源端 IP(对应 value 值可多选)- DestinationIp:目的端 IP(对应 value 值可多选)- TrafficPath:流量路径(对应 value 值可多选)- ClientCountry:按国家过滤流量分析范围(对应 value 值可多选)- ClientCity:按城市过滤流量分析范围(对应 value 值可多选)- ClientAsn:按 ASN 过滤流量分析范围(对应 value 值可多选)- ClientIsp:按客户端运营商过滤流量分析范围(对应 value 值可多选)- TupleDimension 为五元组时,支持:- FlowAction:当流量匹配到相应规则或策略后,对该流量执行的处理动作类型(必填, 对应 value 值不可多选)- VpcId:VPC ID(对应 value 值可多选)- VSwitchId:交换机 ID(对应 value 值可多选)- NetworkInterfaceId:弹性网卡 ID(对应 value 值可多选)- EcsId:云服务器 ECS ID(对应 value 值可多选)- SourceIp:源端 IP- DestinationIp:目的端 IP- TrafficPath:流量路径(对应 value 值可多选)- SourcePort:源端口(对应 value 值可多选)- DestinationPort:目的端口(对应 value 值可多选)- Protocol:网络协议(对应 value 值可多选)- ClientCountry:按国家过滤流量分析范围(对应 value 值可多选)- ClientCity:按城市过滤流量分析范围(对应 value 值可多选)- ClientAsn:按 ASN 过滤流量分析范围(对应 value 值可多选)- ClientIsp:按客户端运营商过滤流量分析范围(对应 value 值可多选)- VPC 场景下,均可按流量指标过滤: - MinBytes:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)- MaxBytes:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)- MinRoundTripTime:指定参与排序的最小 RTT,单位 ms(对应 value 值不可多选)- MaxRoundTripTime:指定参与排序的最大 RTT,单位 ms(对应 value 值不可多选)- MinPackages:指定参与排序的最小包数,单位个(对应 value 值不可多选)- MaxPackages:指定参与排序的最大包数,单位个(对应 value 值不可多选) | FlowAction | - FlowAction - VpcId - VSwitchId - NetworkInterfaceId - CloudIp - DestinationIp - SourceIp - EcsId - TrafficPath - ClientCountry - ClientCity - ClientAsn - ClientIsp - SourcePort - DestinationPort - Protocol - MinBytes - MaxBytes - MinRoundTripTime - MaxRoundTripTime - MinPackages - MaxPackages |
| value | array | 否 | 过滤条件的值。 | - | |
| string | 否 | 根据过滤的 key 类型,传入对应的过滤值。 - 当 key 为 FlowAction 时,value 枚举为:- ACCEPT(默认传 Accept):安全组和网络 ACL 允许的流量- REJECT:安全组和网络 ACL 拒绝的流量 | Accept | - | |
| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in): ● in:等于 ● not in:不等于 ● like:包含 ● 当 key 为以下字段时,支持 like: ○ CloudIp ○ SourceIp ○ DestinationIp 除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in - in - like |
| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |
| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |
| Sort | string | 否 | 指定流量分析的排序方式: ● ASC:按正序排序。 ● DESC:按逆序排序。 | Desc | - Desc - Asc |
| TopN | integer | 否 | 指定流量排序查询的条目数。 支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |
| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN - en-US |
| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |
| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | - |
| StorageInterval | integer | 否 | 存储桶精度属性。 存储桶精度用于查询指定的存储聚合周期。支持高精度(例如 1 分钟)或长周期(例如 1 天)2 种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。 - 流量分析器对应元组支持的存储精度为: - 1:单位分钟(1 分钟)- 10:单位分钟(10 分钟)- 60:单位分钟(60 分钟,即 1 小时)- 1440:单位分钟(1440 分钟,即 1 天)- 存储桶精度可用于两类典型用途: - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合 - 长周期流量统计:如 1440 分钟(1 天)聚合 - 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如: - 传入 10:查询短周期、以 10 分钟为聚合粒度的数据- 传入 1440:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1 - 10 - 60 - 1440 |
返回参数
| 名称 | 类型 | 描述 | 示例值 | 枚举值 |
| object | RpcResponse | - | ||
| RequestId | string | 请求 ID。 | - | |
| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |
全部 TR 流日志分析-TR 跨地域
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |
| RegionNo | string | 是 | 资源所在地域 | cn-shanghai | - |
| TrafficAnalyzerId | string | 是 | 流量分析器 ID | nta-262****ca07f | - |
| TrafficScenario | string | 是 | 支持分析场景: ● 全部 TR 流日志分析 | 固定为:TRFlowLog | TRFlowLog |
| Direction | string | 是 | 基于阿里云资源的网络流量方向。● In:流入 TR 的流量。 ● Out:流出 TR 的流量。 | In | - In - Out |
| TupleDimension | string | 否 | 流量存储聚合维度。 | Tuple2 | - Tuple2 - Tuple5 |
| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | - | |
| string | 否 | (TR 流日志场景,元组自适应,TupleDimension 非必填)支持:- TransitRouterAttachmentId: 网络实例连接 ID(必填)- TransitRouterId:转发路由器实例 ID- SourceIp:源端 IP- DestinationIp:目的端 IP- Dscp:区分服务代码点- Protocol:网络协议- SourcePort:源端端口- DestinationPort:目的端端口 | ["TransitRouterAttachmentId"] | - TransitRouterAttachmentId - TransitRouterId - SourceIp - DestinationIp - Dscp - Protocol - SourcePort - DestinationPort | |
| OrderBy | string | 是 | 支持按以下指标对流量进行排名: - Bytes:带宽- Packets:包数- PacketsLostNoRoute:无路由丢包数- PacketsLostBlackhole:黑洞路由丢包数- PacketsLostTTLExpired:TTL 超时丢包数 | Bytes | - Bytes - Packets - PacketsLostNoRoute - PacketsLostBlackhole - PacketsLostTTLExpired |
| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | - | |
| object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | - | ||
| key | string | 否 | 支持过滤的条件标签键,如下所示: - 查询二元组或自适应为二元组时,支持: - TransitRouterAttachmentId:网络实例连接 ID(必填,对应 value 值不可多选)- TransitRouterPairAttachmentId:对端 TR 连接 ID(对应 value 值可多选)- TransitRouterId:转发路由器实例 ID(对应 value 值可多选)- SourceIp:源端 IP(Operator= like 时对应 value 值不可多选,Operator != like 时对应 value 值可多选)- DestinationIp:目的端 IP(Operator= like 时对应 value 值不可多选,Operator != like 时对应 value 值可多选)- Dscp:区分服务代码点(对应 value 值可多选)- 查询五元组或自适应为五元组时,在二元组支持的基础上,额外支持: - Protocol:网络协议(对应 value 值可多选)- SourcePort:源端端口(对应 value 值可多选)- DestinationPort:目的端端口(对应 value 值可多选)- TR 场景下,均可按流量指标过滤: - MinBytes:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)- MaxBytes:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)- MinPackages:指定参与排序的最小包数,单位个(对应 value 值不可多选)- MaxPackages:指定参与排序的最大包数,单位个(对应 value 值不可多选)- MinPacketsLostNoRoute:最小无路由丢包数,单位个(对应 value 值不可多选)- MinPacketsLostBlackhole:最小黑洞路由丢包数,单位个(对应 value 值不可多选)- MinPacketsLostTTLExpired:最小 TTL 超时丢包数,单位个(对应 value 值不可多选)- MaxPacketsLostNoRoute:最大无路由丢包数,单位个(对应 value 值不可多选)- MaxPacketsLostBlackhole:最大黑洞路由丢包数,单位个(对应 value 值不可多选)- MaxPacketsLostTTLExpired:最大 TTL 超时丢包数,单位个(对应 value 值不可多选) | TransitRouterAttachmentId | - TransitRouterAttachmentId - TransitRouterPairAttachmentId - TransitRouterId - SourceIp - DestinationIp - Dscp - Protocol - SourcePort - DestinationPort - MinBytes - MaxBytes - MinPackages - MaxPackages - MinPacketsLostBlackhole - MaxPacketsLostBlackhole - MinPacketsLostNoRoute - MaxPacketsLostNoRoute - MinPacketsLostTTLExpired - MaxPacketsLostTTLExpired |
| value | array | 否 | 过滤条件的值。 | - | |
| string | 否 | 根据过滤的 key 类型,传入对应的过滤值。 key 为 TransitRouterAttachmentId 时为必传项,对应的 value 同为必填 | tr-attach-dsvbe32hr*** | - | |
| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in): ● in:等于 ● not in:不等于 ● like:包含 ● 当 key 为以下字段时,支持 like: ○ SourceIp ○ DestinationIp 除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in - in - like |
| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |
| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |
| Sort | string | 否 | 指定流量分析的排序方式 ● ASC:按正序排序。 ● DESC:按逆序排序。 | Desc | - Desc - Asc |
| TopN | integer | 否 | 指定流量排序查询的条目数。 支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |
| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN - en-US |
| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |
| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | - |
| StorageInterval | integer | 否 | 存储桶精度属性。 存储桶精度用于查询指定的存储聚合周期。支持高精度(例如 1 分钟)或长周期(例如 1 天)2 种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。 - 流量分析器对应元组支持的存储精度为: - 1:单位分钟(1 分钟)- 10:单位分钟(10 分钟)- 60:单位分钟(60 分钟,即 1 小时)- 1440:单位分钟(1440 分钟,即 1 天)- 存储桶精度可用于两类典型用途: - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合 - 长周期流量统计:如 1440 分钟(1 天)聚合 - 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如: - 传入 10:查询短周期、以 10 分钟为聚合粒度的数据- 传入 1440:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1 - 10 - 60 - 1440 |
返回参数
| 名称 | 类型 | 描述 | 示例值 | 枚举值 |
| object | RpcResponse | - | ||
| RequestId | string | 请求 ID。 | - | |
| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |
共享带宽指标分析
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例 | 枚举值 |
| RegionNo | string | 是 | 资源所在地域 | cn-shanghai | - |
| TrafficAnalyzerId | string | 是 | 流量分析器 ID | nta-262****ca07f | - |
| TrafficScenario | string | 是 | 支持分析场景: ● 共享带宽指标分析 | 固定为:CbwpMetric | CbwpMetric |
| Direction | string | 是 | 基于阿里云资源的网络流量方向。 ● In:流入 EIP 的流量。 ● Out:流出 EIP 的流量。 | In | -In -Out |
| TupleDimension | string | 否 | 流量存储聚合维度。 | Tuple1 | -Tuple1 |
| GroupBy | array | 否 | 支持基于指定的多项流量维度进行聚合排序。 | - | |
| string | 否 | CBWP 指标分析场景,(TupleDimension 非必填)支持:- PublicIpAddress:绑定的 EIP 的公网 IP 地址- BindingResourceType:EIP 所绑定的实例资源类型- BindingResourceId:EIP 所绑定的实例资源 ID- CbwpId:共享带宽包 ID | ["BindingResourceId"] | - BindingResourceId - BindingResourceType - CbwpId - PublicIpAddress | |
| OrderBy | string | 是 | 支持按以下指标对流量进行排名: - Bytes:带宽- Packets:包数 | Bytes | - Bytes - Packets |
| Filter | array | 否 | 支持进一步指定流量的过滤条件,进行聚焦性流量分析。 | - | |
| object | 否 | 指定流量的过滤条件,Key-Value-Operator 对象。 | - | ||
| key | string | 否 | 支持过滤的条件标签键,如下所示: - 按条件过滤,支持: - PublicIpAddress:绑定的 EIP 的公网 IP 地址(Operator = like 时对应 value 值不可多选,Operator != like 时对应 value 值可多选)- BindingResourceType:EIP 所绑定的实例资源类型(对应 value 值可多选)- BindingResourceId:EIP 所绑定的实例资源 ID(对应 value 值可多选)- CbwpId:共享带宽包 ID(必填, 对应 value 值不可多选)- InstanceId:共享带宽包所绑定的 EIP ID(对应 value 值可多选)- CBWP 场景下,均可按流量指标过滤: - MinBytes:指定参与排序的最小流量,单位 Byte(对应 value 值不可多选)- MaxBytes:指定参与排序的最大流量,单位 Byte(对应 value 值不可多选)- MinPackages:指定参与排序的最小包数,单位个(对应 value 值不可多选)- MaxPackages:指定参与排序的最大包数,单位个(对应 value 值不可多选) | CbwpId | - PublicIpAddress - InstanceId - BindingResourceType - BindingResourceId - CbwpId - MinBytes - MaxBytes - MinPackages - MaxPackages |
| value | array | 否 | 过滤条件的值。 | - | |
| string | 否 | 根据过滤的 key 类型,传入对应的过滤值。 key 为 CbwpId 时为必传项,对应的 value 同为必填(指定具体的共享带宽包 ID)。 | cbwp-advb35j2jn3*** | - | |
| Operator | string | 否 | 针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为 in): ● in:等于 ● not in:不等于 ● like:包含 ● 当 key 为以下字段时,支持 like:- PublicIpAddress除以上字段外,其余字段仅支持 in 和 not in 操作符。除以上字段外,其余字段仅支持 in 和 not in 操作符。 | in | - not in - in - like |
| BeginTime | long | 是 | 查询起始时间的毫秒时间戳。 | 1638239092000 | - |
| EndTime | long | 是 | 查询结束时间的毫秒时间戳。 | 1684373700099 | - |
| Sort | string | 否 | 指定流量分析的排序方式 ● ASC:按正序排序。 ● DESC:按逆序排序。 | Desc | - Desc - Asc |
| TopN | integer | 否 | 指定流量排序查询的条目数。 支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 | 10 | - |
| Language | string | 否 | 语言,枚举:zh-CN,en-US | zh-CN | - zh-CN - en-US |
| NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 | 2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ | - |
| MaxResults | integer | 否 | 分页大小,取值范围:1~100,默认值:20。 | 20 | - |
| StorageInterval | integer | 否 | 存储桶精度属性。 存储桶精度用于查询指定的存储聚合周期。支持高精度(例如 1 分钟)或长周期(例如 1 天)2 种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。 - 流量分析器对应元组支持的存储精度为: - 1:单位分钟(1 分钟)- 10:单位分钟(10 分钟)- 60:单位分钟(60 分钟,即 1 小时)- 1440:单位分钟(1440 分钟,即 1 天)- 存储桶精度可用于两类典型用途: - 高精度流量统计:如 1 分钟、10 分钟、60 分钟聚合 - 长周期流量统计:如 1440 分钟(1 天)聚合 - 在查询时为该字段传值,即可指定要查询的存储聚合周期。例如: - 传入 10:查询短周期、以 10 分钟为聚合粒度的数据- 传入 1440:查询长周期、以 1 天为聚合粒度的数据 | 10 | - 1 - 10 - 60 - 1440 |
返回参数
| 名称 | 类型 | 描述 | 示例值 | 枚举值 |
| object | RpcResponse | - | ||
| RequestId | string | 请求 ID。 | - | |
| NisTrafficRankingId | string | 返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 | task-6462a7b4c4a54b**** | - |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
nis:StartNisTrafficRanking |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionNo |
string |
是 |
资源所在地域。 |
cn-shanghai |
| TrafficAnalyzerId |
string |
是 |
流量分析器 ID。 |
nta-262****ca07f |
| TupleDimension |
string |
否 |
流量存储聚合维度。 根据 TraffficScenario 场景:
枚举值:
|
Tuple1 |
| TrafficScenario |
string |
是 |
支持分析场景:
|
VpcFlowLogAll |
| Direction |
string |
是 |
基于阿里云资源的网络流量方向 In:流入目标资源的流量方向。 Out:流出目标资源的流量方向。
|
Out |
| GroupBy |
array |
否 |
支持基于指定的多项流量维度进行聚合排序。 |
|
|
string |
否 |
根据
|
["VpcId"] |
|
| OrderBy |
string |
是 |
根据
|
Bytes |
| Filter |
array<object> |
否 |
支持进一步指定流量的过滤条件,进行聚焦性流量分析。 |
|
|
object |
否 |
指定流量的过滤条件,Key-Value-Operator 对象。 |
||
| Key |
string |
否 |
根据 TupleDimension 字段和 TrafficScenario 字段,支持过滤的条件标签键,如下所示:
|
FlowAction |
| Value |
array |
否 |
过滤条件的值。 |
|
|
string |
否 |
根据过滤的 key 类型,传入对应的过滤值。 根据
|
Accept |
|
| Operator |
string |
否 |
针对指定的 key 类型,部分支持使用操作符,对传入的 value 进行字符串匹配,支持的枚举如下(默认值为
根据
除以上字段外,其余字段仅支持 枚举值:
|
in |
| BeginTime |
integer |
是 |
查询起始时间的毫秒时间戳。 |
1638239092000 |
| EndTime |
integer |
是 |
查询结束时间的毫秒时间戳。 |
1684373700099 |
| Sort |
string |
否 |
指定流量分析的排序方式
|
Desc |
| TopN |
integer |
否 |
指定流量排序查询的条目数。 支持自定义条数,当不传该字段时,在流量分析数据性能支持范围里,会进行用户指定条件下的全部流量数据排序分析。 |
10 |
| Language |
string |
否 |
语言,枚举:zh-CN,en-US |
zh-CN |
| NextToken |
string |
否 |
是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。 |
2A07PfBPlzmmNi/75Qca9SK73UfY48/+WBiREjfVfXqMQxtV8XckOg5lk7F2bhC+ |
| MaxResults |
integer |
否 |
分页大小,取值范围:1~100,默认值:20。 |
20 |
| StorageInterval |
integer |
否 |
存储桶精度属性。 存储桶精度用于查询指定的存储聚合周期。支持高精度(例如 1 分钟)或长周期(例如 1 天)2 种精度,具体的精度由创建或编辑流量分析器时高精度流量统计或长周期流量统计的流量分析采样间隔决定。
枚举值:
|
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
RpcResponse<ArrayList |
||
| RequestId |
string |
请求 ID。 |
4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941 |
| NisTrafficRankingId |
string |
返回本次流量排序分析的结果 ID,需调用 DescribeNisTrafficRanking 接口获取最终分析结果。 |
task-6462a7b4c4a54b**** |
示例
正常返回示例
JSON格式
{
"RequestId": "4DAC4BE1-BEEA-5D84-BE06-E1B796F3B941",
"NisTrafficRankingId": "task-6462a7b4c4a54b****"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Forbidden.NoPermission | The authentication result is successful but the verification fails. | 鉴权结果成功但验证未通过。 |
| 400 | IllegalParam.RegionNo | The specified parameter RegionNo(%s) is illegal. | 指定的参数RegionNo(%s)不合法。 |
| 400 | DuplicatedParam.GroupBy | Duplicate data exists for the specified GroupBy(%s) parameter. | 指定的GroupBy(%s)参数存在重复数据。 |
| 400 | IllegalParam.GroupBy | The specified param of GroupBy (%s) is invalid. | 指定的分组字段(%s)不合法。 |
| 400 | DuplicatedParam.Filter | The specified Filter(%s) parameter has a duplicate Key. | 指定的Filter(%s)参数存在重复Key。 |
| 400 | IllegalParam.UserOwesFees | User (%s) is overdue. | 用户(%s)已欠费. |
| 400 | IllegalParam.UserNotActivated | User (%s) did not provision service. | 用户(%s)未开通服务。 |
| 400 | IncorrectStatus.TrafficAnalyzerId | TrafficAnalyzerId (%s) is not in a valid status. | TrafficAnalyzerId(%s)非有效状态. |
| 400 | IllegalParam.CloudIp | The specified CloudIp(%s) is invalid. | 指定的CloudIp(%s)不合法。 |
| 400 | IllegalParam.SourceIp | Please enter a valid source IP. | 请输入合法的源IP |
| 400 | IllegalParam.SourcePort | The specified SourcePort(%s) value is invalid. The value must be within the range of (0,65536]. | SourcePort参数不合法,必须介于0到65536(含)之间。 |
| 400 | IllegalParam.DestinationPort | The specified DestinationPort(%s) is invalid. | 指定的DestinationPort(%s)参数不合法。 |
| 400 | IllegalParam.Protocol | The specified Protocol(%s) is invalid. | 指定的Protocol(%s)参数不合法。 |
| 400 | IllegalParamFormat.MinBytes | The format of the specified parameter MinBytes(%s) is not legal. | 指定的参数MinBytes(%s)格式不合法。 |
| 400 | IllegalParamFormat.MaxBytes | The format of the specified parameter MaxBytes(%s) is not legal. | 指定的参数MaxBytes(%s)格式不合法。 |
| 400 | IllegalParamFormat.MinRoundTripTime | The format of the specified parameter MinRoundTripTime(%s) is not legal. | 指定的参数MinRoundTripTime(%s)格式不合法。 |
| 400 | IllegalParamFormat.MaxRoundTripTime | The format of the specified parameter MaxRoundTripTime(%s) is not legal. | 指定的参数MaxRoundTripTime(%s)格式不合法。 |
| 400 | IllegalParamFormat.MinPackages | The format of the specified parameter MinPackages(%s) is not legal. | 指定的参数MinPackages(%s)格式不合法。 |
| 400 | IllegalParamFormat.MaxPackages | The format of the specified parameter MaxPackages(%s) is not legal. | 指定的参数MaxPackages(%s)格式不合法。 |
| 400 | IllegalParam.TupleDimension | The specified TupleDimension(%s) argument is illegal. | 指定的TupleDimension(%s)参数不合法。 |
| 400 | IllegalParam.OrderBy | The specified param of orderBy (%s) is invalid. | 指定的排序字段(%s)不合法。 |
| 400 | IllegalParam.BeginTimeAndEndTime | The param of BeginTimeAndEndTime is illegal. | 开始结束时间错误。可能是因为开始时间大于结束时间,或范围超出最大限制 |
| 400 | IllegalParam.DestinationIp | The specified ip(%s) is illegal. | 指定的ip(%s)不合法。 |
| 400 | IllegalParamFormat.MaxPacketsLostTTLExpired | The format of the specified parameter MaxPacketsLostTTLExpired(%s) is not legal. | |
| 400 | IllegalParamFormat.MinPacketsLostTTLExpired | The format of the specified parameter MinPacketsLostTTLExpired(%s) is not legal. | |
| 400 | IllegalParamFormat.MaxPacketsLostNoRoute | The format of the specified parameter MaxPacketsLostNoRoute(%s) is not legal. | |
| 400 | IllegalParamFormat.MinPacketsLostNoRoute | The format of the specified parameter MinPacketsLostNoRoute(%s) is not legal. | |
| 400 | IllegalParamFormat.MaxPacketsLostBlackhole | The format of the specified parameter MaxPacketsLostBlackhole(%s) is not legal. | |
| 400 | IllegalParamFormat.MinPacketsLostBlackhole | The format of the specified parameter MinPacketsLostBlackhole(%s) is not legal. | |
| 400 | IllegalParam.Filter | The specified Filter parameter (%s) is illegal. | |
| 400 | MissingParam.TransitRouterAttachmentId | TransitRouterAttachmentId required in the specified Filter and GroupBy parameters. | |
| 400 | QuotaExceeded.CheckRowReadLimit | The query time range exceeds the read data rows quota %s. Shorten the query interval. | |
| 400 | MissingParam.TransitRouterId | When querying cross-region network connections, you need to specify the forwarding router ID. | |
| 400 | MissingParam.CbwpId | The CbwpId filtered during the query cannot be empty. | 查询时过滤的CbwpId不可为空。 |
| 400 | ResourceNotFound.TrafficAnalyzerIdOneTupleDimension | The specified traffic analyzer does not have a corresponding one-element group storage configuration. | 指定的流量分析器没有对应的一元组存储配置。 |
| 400 | IllegalParam.AttachmentType | Unsupported AttachmentType(%s) type. | 暂不支持的AttachmentType(%s)类型。 |
| 404 | ResourceNotFound.TrafficAnalyzerId | The specified resource TrafficAnalyzerId(%s) does not exist. | 指定的资源TrafficAnalyzerId(%s)不存在。 |
| 404 | ResourceNotFound.NtaNotStorageBucket | The data source bound to the traffic analyzer does not have a corresponding storage configuration. | 该流量分析器绑定的数据源无对应的存储配置。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。