1タプル、2タプル、または5タプルの形式でリージョン間トラフィックデータのランキングをクエリします。リージョン間トラフィックデータは、トラフィック量やパケット数などのメトリックでランク付けできます。
この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに nis(2021-12-16) - GetNisNetworkRanking への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
nis:GetTransitRouterFlowTopN |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BeginTime |
integer |
必須 |
クエリする期間の開始時刻。この値は、1970年1月1日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。クエリできる最大期間は 24 時間です。 |
1684373600099 |
| EndTime |
integer |
必須 |
クエリする期間の終了時刻。この値は、1970年1月1日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。クエリできる最大期間は 24 時間です。 |
1638239093000 |
| TopN |
integer |
任意 |
表示するデータエントリの最大数を指定します。デフォルト値：10。最大値：100。 |
20 |
| Direction |
string |
必須 |
ローカルリージョンまたはローカル IP アドレスにおけるリージョン間トラフィックの方向。有効な値：
|
in |
| GroupBy |
string |
必須 |
リージョン間トラフィックデータをランク付けするためのディメンション。このパラメーターの値は、大文字と小文字が区別されます。有効な値：
|
1Tuple |
| ThisRegion |
string |
任意 |
ローカル IP アドレスが所在するローカルリージョン。 |
cn-shanghai |
| ThisIp |
string |
任意 |
ローカル IP アドレス。 |
1.8.XX.XX |
| ThisPort |
string |
任意 |
ローカルポート。 |
80 |
| OtherRegion |
string |
任意 |
リモートリージョン。 |
ap-southeast-1 |
| OtherIp |
string |
任意 |
リモート IP アドレス。 |
122.112.XX.XX |
| OtherPort |
string |
任意 |
リモートポート。 |
10869 |
| Protocol |
string |
任意 |
プロトコル番号。 説明
すべてのプロトコルがサポートされています。このパラメーターは、GroupBy を 5Tuple または Protocol に設定した場合にのみ必須です。 |
6 |
| OrderBy |
string |
任意 |
リージョン間トラフィックデータをランク付けするためのメトリック。デフォルト値：Bytes。この値は、リージョン間トラフィックデータがトラフィック量でランク付けされることを指定します。 |
Bytes |
| Sort |
string |
任意 |
リージョン間トラフィックデータをランク付けする順序。有効な値：
|
desc |
| CenId |
string |
任意 |
CEN インスタンス ID。 |
cen-ia8kw1zjv4hyal**** |
| BandwithPackageId |
string |
任意 |
CEN 帯域幅プランの ID。 |
cenbwp-ia8kw1zjv4hyal***** |
| AccountIds |
array |
任意 |
メンバーアカウントの ID。 |
|
|
integer |
任意 |
メンバーアカウントの ID。 |
[\"118639953821xxxx\"] |
|
| UseMultiAccount |
boolean |
任意 |
マルチアカウント管理機能を有効にするかどうかを指定します。デフォルト値：false。この値は、マルチアカウント管理機能が無効になっていることを指定します。 説明
デフォルトでは、マルチアカウント管理機能は利用できません。この機能を使用する場合は、アカウントマネージャーに連絡して権限を申請してください。 |
false |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| RequestId |
string |
リクエスト ID。 |
D5E98683-355B-5867-8D3D-A24755F6895B |
| TransitRouterFlowTopN |
array<object> |
リージョン間トラフィックデータのランキング結果。 |
|
|
object |
|||
| AccountId |
string |
アカウント ID。 |
118639953821xxxx |
| CenId |
string |
CEN インスタンス ID。 |
cen-ia8kw1zjv4hyal**** |
| ThisRegion |
string |
ローカル IP アドレスが所在するローカルリージョン。 |
cn-shanghai |
| ThisIp |
string |
ローカル IP アドレス。 |
1.8.XX.XX |
| ThisPort |
string |
ローカルポート。 |
80 |
| OtherRegion |
string |
リモート IP アドレスが所在するリモートリージョン。 |
ap-southeast-1 |
| OtherIp |
string |
リモート IP アドレス。 |
47.216.XX.XX |
| OtherPort |
string |
リモートポート。 |
53470 |
| Protocol |
string |
プロトコル番号。 |
6 |
| StartTime |
string |
クエリした期間の開始時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に従います。時刻は UTC で表示されます。 |
2023-01-31T05:40:00Z |
| EndTime |
string |
クエリした期間の終了時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に従います。時刻は UTC で表示されます。 |
2023-01-31T06:40:00Z |
| Packets |
number |
指定された期間内の合計パケット数。 |
88 |
| Bytes |
number |
指定された期間内の合計トラフィック量。 |
188 |
| BandwithPackageId |
string |
CEN 帯域幅プランの ID。 |
cenbwp-ia8kw1zjv4hyal**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "D5E98683-355B-5867-8D3D-A24755F6895B",
"TransitRouterFlowTopN": [
{
"AccountId": "118639953821xxxx",
"CenId": "cen-ia8kw1zjv4hyal****",
"ThisRegion": "cn-shanghai",
"ThisIp": "1.8.XX.XX",
"ThisPort": "80",
"OtherRegion": "ap-southeast-1",
"OtherIp": "47.216.XX.XX",
"OtherPort": "53470",
"Protocol": "6",
"StartTime": "2023-01-31T05:40:00Z",
"EndTime": "2023-01-31T06:40:00Z",
"Packets": 88,
"Bytes": 188,
"BandwithPackageId": "cenbwp-ia8kw1zjv4hyal****"
}
]
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalParam.TopN | The TopN(%s) should not greater than 100. | |
| 400 | IllegalParam.BeginTime | The specified begin time (%s) is invalid. | |
| 400 | IllegalParam.BeginTimeAndEndTime | It only supports querying data for up to 7 days: %s. | |
| 400 | IllegalParam.OrderBy | The specified param of orderBy (%s) is invalid. | |
| 400 | IllegalParam.Sort | The specified Sort(%s) is invalid. | paramsは（'desc'、'asc'）にある必要があります |
| 400 | IllegalParam.AccountIds | The specified parameter accountId (%s) is invalid. | |
| 400 | IllegalParam.inOrOut | Valid values for the inOrOut parameter: in and out. | params inOrOutはin（'in'、'out'）である必要があります |
| 400 | IllegalParam.EndTime | The specified end time (%s) is invalid. | |
| 400 | IllegalParam.ThisRegion | The specified parameter thisRegion(%s) is illegal. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。