全部產品
Search
文件中心

PolarDB:DescribeGatewayList - 查詢網關執行個體列表

更新時間:Apr 29, 2026

查詢網關執行個體列表

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

POST  HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

PageSize

string

每頁記錄數,取值範圍如下:

  • 30

  • 50

  • 100

預設值為 30

30

PageNumber

string

當前頁碼

1

GwClusterId

string

網關執行個體 ID。

pg-xxxxxxxxxx

GwDescription

string

網關描述

test

RegionId

string

地區 ID。

cn-beijing

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

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

PageNumber

string

查詢頁碼,預設值為 1。

1

PageRecordCount

string

當前頁面記錄數

30

PageSize

string

每頁記錄數,取值範圍如下:

  • 30

  • 50

  • 100

預設值為 30。

30

TotalRecordCount

string

總記錄數。

1

Items

array<object>

網關執行個體列表

object

網關執行個體對象

VpcId

string

專用網路 ID。

vpc-****************

VSwitchId

string

交換器的 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

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情