GetNisNetworkRanking_网络智能服务_API文档

2021-12-16

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

支持分析场景：

NAT 网关 SNAT IP 流量分析场景
公网流量分析场景
跨域流量分析场景
混合云流量分析场景
公网性能观测大盘场景
跨可用区内网性能观测大盘场景
跨地域内网性能观测大盘场景

各场景的具体使用方式请参见此文档。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

nis:GetNisNetworkRanking	None	全部资源 *	无	无

请求参数

字段名称	字段详情
RegionNostring	资源所在地域。示例值:cn-beijing
ResourceTypestring	按流量转发所使用的阿里云网络资源类型进行分析，取值：展开详情示例值:AccessInternetIpV4枚举值:AccessInternetIpV4AccessInternetIpV4LimitedElasticIPPublicIpEcsPublicIpClbNATTRTRAttachmentVBRGAInternetProbingIntranetProbing参考取值来源: ListNisInspectionResourceType
Directionstring	基于阿里云资源的网络流量方向，取值：展开详情示例值:in枚举值:inout
GroupBystring	指定指标排名的维度，各场景取值：展开详情示例值:Protocol枚举值:Tuple1Tuple2Tuple5ProtocolSourcePortDestinationPortCountryCityASNCityASNRegionPairInstanceIdCountryIspZonePairISPIpPairProvinceProvinceIsp
OrderBystring	指定公网流量进行排名的指标。大小写敏感，取值：展开详情示例值:bps枚举值:rttbpsppsRetransmitRateActiveSessionCountNewSessionPerSecondRatelimitDropPpsByteCountPacketCount
Filterarray<object>	支持进一步指定流量的过滤条件，进行聚焦性流量分析。
BeginTimeinteger<int64>	起始时间戳，单位 ms。未指定时默认查最近 1 小时。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1684373600099取值 <= 253402271999000
EndTimeinteger<int64>	结束时间戳，单位 ms。未指定时默认查最近 1 小时。只指定了 BeginTime 时查 BeginTime 之后的 1 小时。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1684379093000取值 <= 253402271999000
Sortstring	排序方式，默认 desc，取值：展开详情示例值:desc枚举值:ascdesc
TopNinteger<int32>	展示排序靠前的数据。默认值：10。表示默认展示排序前 10 的数据。最大值：100。示例值:10取值 <= 100
UseCrossAccountboolean	是否使用多账号访问模式，保留参数，目前不支持。示例值:false
AccountIdsarray<string>	显式传递子账号 ID。子级条数 <= 10

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:A7F0D6EC-E19E-58AC-AC9F-08036763960F
Dataarray<object>	云网络指标排名数据集合。

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	IllegalParam.BeginTimeAndEndTime	It only supports querying data for up to 24 hours: %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.	诊断
400	IllegalParam.OrderBy	The specified param of orderBy (%s) is invalid.	诊断
400	IllegalParam.ResourceType	The specified resourceType (%s) is invalid.	诊断
400	IllegalParam.GroupBy	The specified param of GroupBy (%s) is invalid.	诊断
400	IllegalParam.Direction	The specified direction (%s) is invalid.	诊断
400	IllegalParam.Filter.InstanceId	The specified InstanceId(%s) is illegal.	诊断
400	IllegalParam.BeginTimeAndEndTime5M	It only supports querying data for up to 5 minute when TupleType is 5 and the CloudIp and OtherIp are both empty: %s.	诊断
404	ResourceNotFound.InstanceId	The specified InstanceId(%s) does not exist.	诊断
404	ResourceNotFound.IpSets	The specified instance does not exist or does not have any acceleration region.	诊断

变更历史

暂无变更历史

相关示例