すべてのプロダクト
Search

このプロダクト

    PolarDB:DescribeGatewayList

    ドキュメントセンター

    PolarDB:DescribeGatewayList

    最終更新日:Apr 28, 2026

    ゲートウェイインスタンスのリストを照会します。

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエスト構文

    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
    PageRecordCount

    string

    現在のページで返されたエントリ数。

    30
    PageSize

    string

    1 ページあたりのエントリ数。

    • 30

    • 50

    • 100

    デフォルト値：30。

    30
    TotalRecordCount

    string

    エントリの総数。

    1
    Items

    array<object>

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

    object

    ゲートウェイインスタンスの詳細情報。

    VpcId

    string

    VPC (Virtual Private Cloud) の 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

    ゲートウェイインスタンスの作成時刻。

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

    string

    ゲートウェイインスタンスの最終変更時刻。

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

    string

    ゲートウェイインスタンスの有効期限。

    • サブスクリプションインスタンスの場合、このパラメーターは有効期限を示します。

    • 従量課金インスタンスの場合、このパラメーターは空です。

    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
    }
  ]
}

    エラーコード

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

    変更履歴

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