すべてのプロダクト
Search

このプロダクト

    Platform For AI:ListGateway

    ドキュメントセンター

    Platform For AI:ListGateway

    最終更新日:Jan 14, 2026

    非公開ゲートウェイを一覧表示します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    eas:ListGateway

    list

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /api/v2/gateways HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    GatewayId

    string

    任意

    非公開ゲートウェイの ID。ListResources 操作の応答の private_gateway_id フィールドから ID を取得できます。

    gw-1uhcqmsc7x22******
    PageNumber

    integer

    任意

    返すゲートウェイリストのページ番号。デフォルト値は 1 です。

    1
    PageSize

    integer

    任意

    各ページで返すゲートウェイの数。デフォルト値は 100 です。

    100
    GatewayName

    string

    任意

    非公開ゲートウェイのエイリアス。

    mygateway1
    ResourceName

    string

    任意

    リソースグループの ID。ListResources 操作の応答の ResourceId フィールドから ID を取得できます。

    eas-r-4gt8twzwllfo******
    InternetEnabled

    boolean

    任意

    パブリックネットワーク経由のアクセスを有効にするかどうかを指定します。

    true
    Status

    string

    任意

    ゲートウェイのステータス。

    Running
    ChargeType

    string

    任意

    課金方法。

    列挙値:

    • PostPaid :

      従量課金

    • PrePaid :

      サブスクリプション

    PrePaid
    Sort

    string

    任意

    ソート基準のフィールド。

    列挙値:

    • Status :

      ステータス

    • ChargeType :

      課金方法

    • CreateTime :

      作成時間

    • UpdateTime :

      更新時間

    • InternetEnabled :

      パブリックネットワークアクセス

    • GatewayType :

      ゲートウェイタイプ

    • GatewayName :

      ゲートウェイ名

    CreateTime
    Order

    string

    任意

    ソート順。

    列挙値:

    • asc :

      昇順

    • desc :

      降順

    asc
    GatewayType

    string

    任意

    ゲートウェイのタイプ。

    列挙値:

    • FullyManaged :

      フルマネージド専用ゲートウェイ

    • Application :

      アプリケーション専用ゲートウェイ

    Application
    Label

    object

    任意

    タグによるフィルター。

    string

    任意

    フィルターに使用するタグ。{"key":"value"} 形式で指定します。値を null または空の文字列に設定すると、キーのみでフィルターできます。

    {"key1":"value1","key2":null}

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返された結果。

    RequestId

    string

    リクエスト ID。

    40325405-579C-4D82****
    Gateways

    array<object>

    非公開ゲートウェイのリスト。

    array<object>

    非公開ゲートウェイの詳細。

    GatewayId

    string

    非公開ゲートウェイの ID。

    gw-1uhcqmsc7x22******
    GatewayName

    string

    非公開ゲートウェイのエイリアス。

    mygateway1
    InstanceType

    string

    非公開ゲートウェイで使用されるインスタンスタイプ。

    2c4g
    IntranetDomain

    string

    内部ネットワークエンドポイント。

    gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
    InternetEnabled

    boolean

    パブリックネットワークアクセスが有効になっているかどうかを示します。

    true
    InternetDomain

    string

    パブリックネットワークエンドポイント。

    gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com
    CreateTime

    string

    非公開ゲートウェイが作成された時間。時刻は UTC です。

    2020-05-19T14:19:42Z
    UpdateTime

    string

    非公開ゲートウェイが最後に更新された時間。時刻は UTC です。

    2021-02-24T11:52:17Z
    Status

    string

    非公開ゲートウェイのステータス。

    列挙値:

    • Creating :

      ゲートウェイは作成中です。

    • Stopped :

      ゲートウェイは停止しています。

    • Failed :

      ゲートウェイは失敗しました。

    • Running :

      ゲートウェイは実行中です。

    • Deleted :

      ゲートウェイは削除されました。

    • Deleting :

      ゲートウェイは削除中です。

    • Waiting :

      ゲートウェイは待機中です。

    Running
    Replicas

    integer

    非公開ゲートウェイのノード数。

    2
    IsDefault

    boolean

    デフォルトの非公開ゲートウェイであるかどうかを示します。

    true
    ChargeType

    string

    課金方法。有効な値：

    • PrePaid: サブスクリプション。

    • PostPaid: 従量課金。

    PostPaid
    SSLRedirectionEnabled

    boolean

    HTTP から HTTPS へのリダイレクトが有効になっているかどうかを示します。

    true
    IntranetEnabled

    boolean

    内部ネットワークアクセスが有効になっているかどうかを示します。

    Labels

    array<object>

    ゲートウェイタグのリスト。

    object

    ゲートウェイタグオブジェクト。

    LabelKey

    string

    ゲートウェイタグのキー。

    key1
    LabelValue

    string

    ゲートウェイタグの値。

    value1
    PageNumber

    integer

    返されたページのページ番号。

    1
    PageSize

    integer

    ページごとに返されるエントリ数。

    100
    TotalCount

    integer

    ゲートウェイの総数。

    5

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "40325405-579C-4D82****",
  "Gateways": [
    {
      "GatewayId": "gw-1uhcqmsc7x22******",
      "GatewayName": "mygateway1",
      "InstanceType": "2c4g",
      "IntranetDomain": "gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com",
      "InternetEnabled": true,
      "InternetDomain": "gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-02-24T11:52:17Z",
      "Status": "Running",
      "Replicas": 2,
      "IsDefault": true,
      "ChargeType": "PostPaid",
      "SSLRedirectionEnabled": true,
      "IntranetEnabled": false,
      "Labels": [
        {
          "LabelKey": "key1",
          "LabelValue": "value1"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 5
}

    エラーコード

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

    変更履歴

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