すべてのプロダクト
Search

このプロダクト

    Network Intelligence Service:GetNatTopN

    ドキュメントセンター

    Network Intelligence Service:GetNatTopN

    最終更新日:Dec 21, 2025

    NAT ゲートウェイのリアルタイム SNAT パフォーマンスランキングをクエリします。

    説明

    この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに nis(2021-12-16) - GetNisNetworkRanking への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    nis:GetNatTopN

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    NAT ゲートウェイがデプロイされているリージョンの ID です。

    cn-shanghai
    NatGatewayId

    string

    必須

    NAT ゲートウェイの ID です。

    ngw-sample***
    BeginTime

    integer

    必須

    クエリする時間範囲の開始時刻 (ミリ秒単位のタイムスタンプ)。 EndTime を指定しない場合、BeginTime で指定された時点がクエリされます。

    1638239092000
    EndTime

    integer

    任意

    クエリする時間範囲の終了時刻 (ミリ秒単位のタイムスタンプ)。 BeginTime と EndTime で指定する時間範囲は、86400000 ミリ秒 (24 時間) を超えることはできません。

    1638239093000
    OrderBy

    string

    任意

    リアルタイム SNAT パフォーマンスランキングに使用されるメトリックです。 有効値：

    • InBps：インバウンドデータ転送。 単位：bit/s。

    • OutBps：アウトバウンドデータ転送。 単位：bit/s。

    • InPps：インバウンドパケット転送速度。 単位：pps (1 秒あたりのパケット数)。

    • OutPps：アウトバウンドパケット転送速度。 単位：pps (1 秒あたりのパケット数)。

    • NewSessionPerSecond：新規接続作成レート。 単位：cps (1 秒あたりの接続数)。

    • ActiveSessionCount：同時接続数。 単位：接続。

    InBps
    TopN

    integer

    任意

    リアルタイム SNAT パフォーマンスランキングで返すエントリ数。 有効値：1～100。 デフォルト値：10。

    10
    Ip

    string

    任意

    特定の IP アドレスのランキング統計をクエリします。 このパラメーターを指定する場合、TopN または OrderBy を指定する必要はありません。

    192.168.156.101

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID です。

    77C512B5-12f3-f892-BD94-88A98271C1A0
    NatGatewayTopN

    array<object>

    リアルタイム SNAT パフォーマンスランキングに関する統計の配列です。

    object

    リアルタイム SNAT パフォーマンスランキングの統計に含まれるフィールドです。 フィールドの値は、BeginTime から EndTime までの時間範囲内の平均値です。

    Ip

    string

    IP アドレスです。

    192.168.156.101
    InBps

    number

    インバウンドデータ転送。 単位：bit/s。

    100
    OutBps

    number

    アウトバウンドデータ転送。 単位：bit/s。

    200
    InPps

    number

    インバウンドパケット転送速度。 単位：pps (1 秒あたりのパケット数)。

    10
    OutPps

    number

    アウトバウンドパケット転送速度。 単位：pps (1 秒あたりのパケット数)。

    20
    InFlowPerMinute

    number

    このフィールドは予約済みであり、使用されていません。

    10
    OutFlowPerMinute

    number

    このフィールドは予約済みであり、使用されていません。

    10
    NewSessionPerSecond

    number

    新規接続作成レート。 単位：cps (1 秒あたりの接続数)。

    2
    ActiveSessionCount

    number

    同時接続数。 単位：接続。

    8
    IsTopNOpen

    boolean

    Network Intelligence Service (NIS) が有効化されているかどうかを示します。 NIS が有効化されていない場合、NatGatewayTopN パラメーターは空の配列を返します。

    • true：有効化されています。

    • false：有効化されていません。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "77C512B5-12f3-f892-BD94-88A98271C1A0",
  "NatGatewayTopN": [
    {
      "Ip": "192.168.156.101",
      "InBps": 100,
      "OutBps": 200,
      "InPps": 10,
      "OutPps": 20,
      "InFlowPerMinute": 10,
      "OutFlowPerMinute": 10,
      "NewSessionPerSecond": 2,
      "ActiveSessionCount": 8
    }
  ],
  "IsTopNOpen": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalParam.TopN The TopN(%s) should not greater than 100.
    400 IllegalParam.BeginTimeAndEndTime It only supports querying data for up to 7 days: %s.
    400 IllegalParam.ResourceId The specified resourceId (%s) may be not exist.
    400 IllegalParam.OrderBy The specified param of orderBy (%s) is invalid.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。