すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeGatewayList

    ドキュメントセンター

    PolarDB:DescribeGatewayList

    最終更新日: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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:DescribeGatewayList

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエスト構文

    POST  HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageSize

    string

    任意

    1 ページあたりのエントリ数。有効な値:

    • 30

    • 50

    • 100

    デフォルト値: 30。

    30
    PageNumber

    string

    任意

    現在のページ番号。

    1
    GwClusterId

    string

    任意

    ゲートウェイインスタンスの ID。

    pg-xxxxxxxxxx
    GwDescription

    string

    任意

    ゲートウェイの説明。

    test
    RegionId

    string

    必須

    リージョン ID。

    cn-beijing

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスのスキーマ。

    RequestId

    string

    リクエストの ID。

    CED079B7-A408-41A1-BFF1-EC608E******
    PageNumber

    string

    ページ番号。デフォルト値: 1。

    1
    PageRecordCount

    string

    現在のページのエントリ数。

    30
    PageSize

    string

    1 ページあたりのエントリ数。有効な値:

    • 30

    • 50

    • 100

    デフォルト値: 30。

    30
    TotalRecordCount

    string

    エントリの総数。

    1
    Items

    array<object>

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

    object

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

    VpcId

    string

    VPC の ID。

    vpc-****************
    VSwitchId

    string

    vSwitch の ID。

    vsw-wz9u0v2yuskt1gth3uuju
    PayType

    string

    課金方法。有効な値:

    • Postpaid: 従量課金。

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

    Postpaid
    GwClusterId

    string

    ゲートウェイインスタンスの ID。

    pg-xxxxxxx
    GwDescription

    string

    ゲートウェイの説明。

    pg-xxxxxx
    Status

    string

    アプリケーションステータス。有効な値:

    • CREATE: 作成中。

    • ACTIVATION: 実行中。

    ACTIVATION
    RegionId

    string

    リージョン ID。

    cn-beijing
    DbType

    string

    データベースタイプ。

    polardb_mysql
    CreateTime

    string

    作成時間。

    時間は ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2020-08-14T05:58:42Z
    ModifyTime

    string

    最終更新時間。

    時間は ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2024-10-29T09:31:37Z
    ExpireTime

    string

    クラスターの有効期限。

    • クラスターの課金方法がサブスクリプションの場合、実際の有効期限が返されます。

    • クラスターの課金方法が従量課金の場合、空の値が返されます。

    時間は ISO 8601 フォーマットの協定世界時 (UTC) (フォーマット: YYYY-MM-DDTHH:mm:ssZ) です。

    2028-09-01T16:00:00Z
    Expired

    boolean

    クラスターが期限切れかどうかを示します。有効な値:

    • true

    • false

    false

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CED079B7-A408-41A1-BFF1-EC608E******",
  "PageNumber": "1",
  "PageRecordCount": "30",
  "PageSize": "30",
  "TotalRecordCount": "1",
  "Items": [
    {
      "VpcId": "vpc-****************",
      "VSwitchId": "vsw-wz9u0v2yuskt1gth3uuju",
      "PayType": "Postpaid",
      "GwClusterId": "pg-xxxxxxx",
      "GwDescription": "pg-xxxxxx",
      "Status": "ACTIVATION",
      "RegionId": "cn-beijing",
      "DbType": "polardb_mysql",
      "CreateTime": "2020-08-14T05:58:42Z",
      "ModifyTime": "2024-10-29T09:31:37Z",
      "ExpireTime": "2028-09-01T16:00:00Z",
      "Expired": false
    }
  ]
}

    エラーコード

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

    変更履歴

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