All Products
Search

This Product

    PolarDB:DescribeGatewayList

    Document Center

    PolarDB:DescribeGatewayList

    Last Updated:Sep 24, 2026

    Queries a list of gateway instances.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    polardb:DescribeGatewayList

    get

    *All Resource

    *

    		 None None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    PageSize

    string

    No

    The number of entries per page. Valid values:

    • 30

    • 50

    • 100

    Default value: 30.

    30
    PageNumber

    string

    No

    The current page number.

    1
    GwClusterId

    string

    No

    The gateway instance ID.

    pg-xxxxxxxxxx
    GwDescription

    string

    No

    The gateway description.

    test
    RegionId

    string

    Yes

    The region ID.

    cn-beijing

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

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

    string

    The page number. Default value: 1.

    1
    PageRecordCount

    string

    The number of entries on the current page.

    30
    PageSize

    string

    The number of entries per page. Valid values:

    • 30

    • 50

    • 100

    Default value: 30.

    30
    TotalRecordCount

    string

    The total number of entries.

    1
    Items

    array<object>

    The list of gateway instances.

    object

    The gateway instance object.

    VpcId

    string

    The VPC ID.

    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 gateway description.

    pg-xxxxxx
    Status

    string

    The application status. Valid values:

    • CREATE: being created.

    • ACTIVATION: running.

    ACTIVATION
    RegionId

    string

    The region ID.

    cn-beijing
    DbType

    string

    The database type.

    polardb_mysql
    CreateTime

    string

    The creation time.

    The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).

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

    string

    The last modification time.

    The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).

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

    string

    The expiration time of the cluster.

    • If the billing method of the cluster is subscription, the actual expiration time is returned.

    • If the billing method of the cluster is pay-as-you-go, an empty value is returned.

    The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).

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

    boolean

    Indicates whether the cluster has expired. Valid values:

    • true

    • false

    false

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.