DescribeGatewayList - PolarDB - Alibaba Cloud Documentation Center

Mengkueri daftar Instans gerbang.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
PageSize	string	No	Jumlah entri per halaman. Nilai valid: 30 50 100 Nilai default: 30.	30
PageNumber	string	No	Nomor halaman.	1
GwClusterId	string	No	ID Instans gerbang.	pg-xxxxxxxxxx
GwDescription	string	No	Deskripsi Instans gerbang.	test
RegionId	string	Yes	ID Wilayah.	cn-beijing

Elemen respons

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	CED079B7-A408-41A1-BFF1-EC608E******
PageNumber	string	The page number.	1
PageRecordCount	string	The number of entries returned on the current page.	30
PageSize	string	The number of entries per page. 30 50 100 Default value: 30.	30
TotalRecordCount	string	The total number of entries.	1
Items	array<object>	A list of gateway instances.
	object	Details of a gateway instance.
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-****************
VSwitchId	string	The vSwitch ID.	vsw-wz9u0v2yuskt1gth3uuju
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Postpaid
GwClusterId	string	The gateway instance ID.	pg-xxxxxxx
GwDescription	string	The description of the gateway instance.	pg-xxxxxx
Status	string	The status of the gateway instance. Valid values: CREATE: creating ACTIVATION: running	ACTIVATION
RegionId	string	The region ID.	cn-beijing
DbType	string	The database type.	polardb_mysql
CreateTime	string	The time when the gateway instance was created.	2020-08-14T05:58:42Z
ModifyTime	string	The time when the gateway instance was last modified.	2024-10-29T09:31:37Z
ExpireTime	string	The expiration time of the gateway instance. For subscription instances, this parameter indicates the expiration time. This parameter is empty for pay-as-you-go instances.	2028-09-01T16:00:00Z
Expired	boolean	Indicates whether the gateway instance has expired. Valid values: true false	false

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.