すべてのプロダクト
Search

このプロダクト

    Platform For AI:ListGatewayDomains

    ドキュメントセンター

    Platform For AI:ListGatewayDomains

    最終更新日:Nov 12, 2025

    プライベートゲートウェイのカスタムドメイン名をリストします。

    今すぐお試しください

    この 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:ListGatewayDomains

    list

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ClusterId

    string

    必須

    プライベートゲートウェイが配置されているリージョン。

    cn-shanghai
    GatewayId

    string

    必須

    プライベートゲートウェイの ID。この ID を取得するには、ListGateway API 操作の応答にある GatewayId フィールドをご参照ください。

    gw-1uhcqmsc7x22******

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返された結果。

    RequestId

    string

    リクエスト ID。

    40325405-579C-4D82****
    Message

    string

    リクエストに対して返されたメッセージ。

    Successfully get custom domains
    CustomDomains

    array<object>

    カスタムドメイン名のリスト。

    object

    カスタムドメイン名の詳細。

    Type

    string

    ドメイン名のタイプ。

    列挙値:

    • intranet :

      内部の同一リージョンエンドポイント

    • internet :

      パブリックドメイン名

    intranet
    CertificateId

    string

    ドメイン名にアタッチされている SSL 証明書の ID。証明書 ID を取得するには、デジタル証明書管理サービスコンソールで証明書をアップロードまたは購入します。

    1473**25
    Domain

    string

    カスタムドメイン名。

    test.com
    CertificateName

    string

    SSL 証明書の名前。

    cert-9955038
    CertificateStartDate

    string

    証明書の発行日。

    2018-07-13
    CertificateEndDate

    string

    証明書の有効期限。

    2023-10-25
    CreateTime

    string

    ドメイン名が作成された時間。

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

    string

    ドメイン名が最後に更新された時間。

    2021-05-19T14:19:42Z
    CertificateStatus

    string

    ドメイン名のステータス。

    列挙値:

    • Succeeded :

      操作は成功しました。

    • Failed :

      操作は失敗しました。

    • Attaching :

      証明書はアタッチ中です。

    • Deleting :

      ドメイン名は削除中です。

    Succeeded

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "40325405-579C-4D82****",
  "Message": "Successfully get custom domains",
  "CustomDomains": [
    {
      "Type": "intranet",
      "CertificateId": "1473**25",
      "Domain": "test.com",
      "CertificateName": "cert-9955038",
      "CertificateStartDate": "2018-07-13",
      "CertificateEndDate": "2023-10-25",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-05-19T14:19:42Z",
      "CertificateStatus": "Succeeded"
    }
  ]
}

    エラーコード

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

    変更履歴

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