すべてのプロダクト
Search

このプロダクト

    Platform For AI:DescribeGateway

    ドキュメントセンター

    Platform For AI:DescribeGateway

    最終更新日:Sep 24, 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:DescribeGateway

    get

    *Gateway。

    acs:eas:{#regionId}:{#accountId}:gateway/{#GatewayId}

    		 なし なし

    リクエスト構文

    GET /api/v2/gateways/{ClusterId}/{GatewayId} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ClusterId

    string

    必須

    専用ゲートウェイが属するリージョン。

    cn-wulanchabu
    GatewayId

    string

    必須

    専用ゲートウェイの ID。専用ゲートウェイ ID を取得するには、 ListResources 操作の応答内の private_gateway_id フィールドを参照してください。

    gw-1uhcqmsc7x22******

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答。

    RequestId

    string

    リクエスト ID。

    40325405-579C-4D82****
    GatewayId

    string

    専用ゲートウェイの ID。

    gw-1uhcqmsc7x22******
    GatewayName

    string

    専用ゲートウェイのエイリアス。

    myゲートウェイ1
    CreateTime

    string

    専用ゲートウェイが作成された時間。時間は協定世界時 (UTC) です。

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

    string

    専用ゲートウェイが最後に更新された時間。時間は協定世界時 (UTC) です。

    2021-02-24T11:52:17Z
    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
    InstanceType

    string

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

    列挙値:

    • 8c16g :

      8c16g

    • 4c8g :

      4c8g

    • 2c4g :

      2c4g

    • 16c32g :

      16c32g

    2c4g
    Status

    string

    専用ゲートウェイのステータス。有効な値:

    列挙値:

    • Creating :

      作成中。

    • Stopped :

      停止。

    • Failed :

      失敗。

    • Running :

      実行中。

    • Deleted :

      削除済み。

    • Deleting :

      削除中。

    • Waiting :

      待機中。

    Running
    ExternalClusterId

    string

    セルフマネージドクラスターの ID。

    c935eadf284c14c2da57a2a13ad6******
    Replicas

    integer

    専用ゲートウェイ内のノード数。

    2
    IsDefault

    boolean

    専用ゲートウェイがデフォルトゲートウェイかどうかを示します。

    true
    InternetStatus

    string

    パブリックネットワークアクセスのステータス。有効な値:

    列挙値:

    • Creating :

      パブリックネットワークアクセスを有効化中。

    • Failed :

      パブリックネットワークアクセスの有効化または削除に失敗。

    • Running :

      パブリックネットワークアクセスは実行中。

    • Deleted :

      パブリックネットワークアクセスは削除済み。

    • Deleting :

      パブリックネットワークアクセスを削除中。

    Running
    SSLRedirectionEnabled

    boolean

    HTTP から HTTPS へのリダイレクトが有効かどうかを示します。

    true
    ChargeType

    string

    課金方法。有効な値:

    列挙値:

    • PrePaid（预付费） :

      PrePaid (サブスクリプション)

    • PostPaid（后付费） :

      PostPaid (従量課金)

    PrePaid
    IntranetEnabled

    boolean

    内部ネットワークアクセスが有効かどうかを示します。値が true の場合、内部ネットワークアクセスが有効であることを示します。値が false の場合、内部ネットワークアクセスが無効であることを示します。

    true
    Labels

    array<object>

    ゲートウェイラベルのリスト。

    object

    ゲートウェイラベルオブジェクト。

    LabelKey

    string

    ゲートウェイラベルのキー。

    key1
    LabelValue

    string

    ゲートウェイラベルの値。

    値1

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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