調用GetVbrFlowTopN介面,擷取混合雲流量詳情資料排名,覆蓋一元組、二元組、五元組粒度,支援按流量、包數等指標排序。
目前該API介面已標記為棄用,推薦使用替代API:nis(2021-12-16) - GetNisNetworkRanking。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
nis:GetVbrFlowTopN |
list |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
雲端地區。 |
cn-shanghai |
| BeginTime |
integer |
是 |
查詢起始時間的毫秒時間戳記。最大支援查 24 小時跨度的資料。 |
1638239092000 |
| EndTime |
integer |
是 |
查詢結束時間的毫秒時間戳記。最大支援查 24 小時跨度的資料。 |
1638239093000 |
| Direction |
string |
是 |
對於當前地區或 IP 的流量方向。
|
in |
| GroupBy |
string |
是 |
指定混合雲流量排名的維度,大小寫敏感,注意區分大小寫。取值:
|
1Tuple |
| OrderBy |
string |
否 |
資料排序的指標。預設值:Bytes,表示按流量排序。 |
Bytes |
| Sort |
string |
否 |
排序方式。取值:
|
desc |
| TopN |
integer |
否 |
展示排序靠前的資料。預設值:10。表示預設展示排序前 10 的資料。最大 100。 |
10 |
| CenId |
string |
否 |
CEN 執行個體 ID。 |
cen-ia8kw1zjv4hyal**** |
| VirtualBorderRouterId |
string |
否 |
專線 VBR 執行個體 ID。 |
vbr-k1atj46citwuek42j**** |
| AttachmentId |
string |
否 |
CEN 的串連 ID。 |
tr-attach-dnv870gmqzmb5u**** |
| Protocol |
string |
否 |
協議號。 說明
支援全部協議,僅 GroupBy 配置為 5Tuple 或 Protocol 時,才需要配置該參數。 |
6 |
| CloudIp |
string |
否 |
雲端 IP。 |
112.74.XX.XX |
| OtherIp |
string |
否 |
IDC 側 IP。 |
122.112.XX.XX |
| CloudPort |
string |
否 |
雲端連接埠號碼。 說明
僅 GroupBy 配置為 CloudPort 時,才需要配置該參數。 |
443 |
| OtherPort |
string |
否 |
IDC 側連接埠號碼。 說明
僅 GroupBy 配置為 OtherPort 時,才需要配置該參數。 |
40002 |
| AccountIds |
array |
否 |
成員帳號 ID 列表。 |
|
|
integer |
否 |
某個成員帳號 ID。 |
[\"118639953821****\"] |
|
| UseMultiAccount |
boolean |
否 |
是否使用多帳號管理功能。預設值:false。表示不使用。 說明
多帳號管理功能預設不開放,如需使用,請聯絡商務經理申請使用許可權。 |
false |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
RpcResponse |
||
| RequestId |
string |
請求 ID。 |
A7F0D6EC-E19E-58AC-AC9F-08036763960F |
| VirtualBorderRouterFlowlogTopN |
array<object> |
混合雲流量詳情排名列表。 |
|
|
object |
混合雲流量詳情。 |
||
| CloudRegion |
string |
雲端 IP 對應的雲端地區。 |
cn-shanghai |
| CloudIp |
string |
雲端 IP。 |
120.24.X.X |
| OtherIp |
string |
IDC 側 IP。 |
222.85.X.X |
| CloudPort |
string |
雲端連接埠。 |
80 |
| OtherPort |
string |
IDC 側連接埠。 |
10965 |
| Protocol |
string |
協議號。 |
6 |
| AttachmentId |
string |
CEN 的串連 ID。 |
tr-attach-u6v1j3jre0fe9h**** |
| VirtualBorderRouterId |
string |
專線 ID。 |
vbr-k1atj46citwuek42j**** |
| Bytes |
number |
指定時間段內的流量總和。 |
108 |
| Packets |
number |
指定時間段內的發包數總和。 |
66 |
| AccountId |
string |
帳號 ID。 |
156237031628**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "A7F0D6EC-E19E-58AC-AC9F-08036763960F",
"VirtualBorderRouterFlowlogTopN": [
{
"CloudRegion": "cn-shanghai",
"CloudIp": "120.24.X.X",
"OtherIp": "222.85.X.X",
"CloudPort": "80",
"OtherPort": "10965",
"Protocol": "6",
"AttachmentId": "tr-attach-u6v1j3jre0fe9h****",
"VirtualBorderRouterId": "vbr-k1atj46citwuek42j****",
"Bytes": 108,
"Packets": 66,
"AccountId": "156237031628****"
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | IllegalParam.TopN | The TopN(%s) should not greater than 100. | 最大僅支援Top 100,實際傳入為(%s)。 |
| 400 | IllegalParam.BeginTime | The specified begin time (%s) is invalid. | 指定的開始時間(%s)不合法。 |
| 400 | IllegalParam.BeginTimeAndEndTime | It only supports querying data for up to 7 days: %s. | 最大僅支援查詢7天的資料:%s。 |
| 400 | IllegalParam.Sort | The specified Sort(%s) is invalid. | 排序欄位必須為('desc','asc')其中之一 |
| 400 | IllegalParam.OrderBy | The specified param of orderBy (%s) is invalid. | 指定的排序欄位(%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.RegionId | The specified region ID (%s) is invalid. | 指定的地區(%s)不合法。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。