支持通過排序算法和數據處理能力,對流經不同云網絡資源的流量進行排名分析,以及對阿里云性能觀測的探測指標進行排序,幫助您快速識別網絡瓶頸、優化資源配置和提升整體網絡效能。
接口說明
支持分析場景:
- NAT 網關 SNAT IP 流量分析場景
- 公網流量分析場景
- 跨域流量分析場景
- 混合云流量分析場景
- 公網性能觀測大盤場景
- 跨可用區內網性能觀測大盤場景
- 跨地域內網性能觀測大盤場景
各場景的具體使用方式請參見此文檔。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
nis:GetNisNetworkRanking | none |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionNo | string | 是 | 資源所在地域。 | cn-beijing |
ResourceType | string | 是 | 按流量轉發所使用的阿里云網絡資源類型進行分析,取值:
| AccessInternetIpV4 |
Direction | string | 是 | 基于阿里云資源的網絡流量方向,取值:
注意 跨域流量分析因只采集出向流量,所以傳入 in 也以 out 處理。
地域內性能觀測和地域間性能觀測因需在 Filter 內指定源或目的,所以指定 Direction 無效。 | in |
GroupBy | string | 是 | 指定指標排名的維度,各場景取值:
流量統計排名分析:
網絡訪問性能排名分析:
| Protocol |
OrderBy | string | 是 | 指定公網流量進行排名的指標。大小寫敏感,取值:
| bps |
Filter | array<object> | 否 | 支持進一步指定流量的過濾條件,進行聚焦性流量分析。 | |
object | 否 | 查詢資源時的篩選條件列表。 | ||
Name | string | 否 | 過濾條件的名字。 | instanceId |
Value | string | 否 | 過濾條件的值。 | lb-2zxxxxz1d |
BeginTime | long | 否 | 起始時間戳,單位 ms。未指定時默認查最近 1 小時。 | 1684373600099 |
EndTime | long | 否 | 結束時間戳,單位 ms。未指定時默認查最近 1 小時。只指定了 BeginTime 時查 BeginTime 之后的 1 小時。 | 1684379093000 |
Sort | string | 否 | 排序方式,默認 desc,取值:
| desc |
TopN | integer | 否 | 展示排序靠前的數據。默認值:10。表示默認展示排序前 10 的數據。最大值:100。 | 10 |
UseCrossAccount | boolean | 否 | 是否使用多賬號訪問模式,保留參數,目前不支持。 | false |
AccountIds | array | 否 | 顯式傳遞子賬號 ID。 | |
string | 否 | 成員賬號 ID 列表。 | 118639953821**** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
"Data": [
{
"RegionNo": "cn-shenzhen",
"InstanceId": "eip-sample*",
"BandwidthPackageId": "cbwp-sample*",
"SourceIp": "42.120.XX.XX",
"SourcePort": "443",
"SourceIsp": "移動",
"DestinationIp": "2.2.XX.XX",
"DestinationPort": "80",
"DestinationIsp": "阿里云",
"Protocol": "6",
"Country": "中國",
"Province": "四川省",
"City": "成都市",
"Isp": "移動",
"Asn": "129103",
"IP": "120.238.XX.XX",
"DestinationRegionNo": "cn-hangzhou",
"VbrId": "vbr-sample*",
"AttachmentId": "tr-sample*",
"SourceZone": "cn-hangzhou-a",
"DestinationZone": "cn-hangzhou-b",
"ByteCount": 1024,
"PacketCount": 66,
"RTT": 23,
"RetransmitRate": 0.1,
"InBps": 10,
"InPps": 3,
"OutBps": 88,
"OutPps": 8,
"NewSessionPerSecond": 18,
"ActiveSessionCount": 66
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.BeginTimeAndEndTime | It only supports querying data for up to 24 hours: %s. | 最大支持查詢24小時數據。 |
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. | 指定的排序字段(%s)不合法。 |
400 | IllegalParam.ResourceType | The specified resourceType (%s) is invalid. | 指定的ResourceType變量值(%s)不存在。 |
400 | IllegalParam.GroupBy | The specified param of GroupBy (%s) is invalid. | 指定的分組字段(%s)不合法。 |
400 | IllegalParam.Direction | The specified direction (%s) is invalid. | 指定的Direction參數不合法,請修改。 |
400 | IllegalParam.Filter.InstanceId | The specified InstanceId(%s) is illegal. | 指定的InstanceId(%s)參數非法。 |
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. | 當TupleType=5且CloudIp、OtherIp都是空時,只支持查詢最長5分鐘范圍的數據。 |
404 | ResourceNotFound.InstanceId | The specified InstanceId(%s) does not exist. | 指定的InstanceId(%s)不存在。 |
404 | ResourceNotFound.IpSets | The specified instance does not exist or does not have any acceleration region. | 指定的實例不存在或者沒有加速區域。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史