All Products
Search

This Product

    Platform For AI:ListGateway

    Document Center

    Platform For AI:ListGateway

    Last Updated:Jan 14, 2026

    Lists private gateways.

    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

    eas:ListGateway

    list

    *All Resource

    *

    		 None None

    Request syntax

    GET /api/v2/gateways HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    GatewayId

    string

    No

    The ID of the private gateway. You can obtain the ID from the private_gateway_id field in the response of the ListResources operation.

    gw-1uhcqmsc7x22******
    PageNumber

    integer

    No

    The page number of the gateway list to return. The default value is 1.

    1
    PageSize

    integer

    No

    The number of gateways to return on each page. The default value is 100.

    100
    GatewayName

    string

    No

    The alias of the private gateway.

    mygateway1
    ResourceName

    string

    No

    The ID of the resource group. You can obtain the ID from the ResourceId field in the response of the ListResources operation.

    eas-r-4gt8twzwllfo******
    InternetEnabled

    boolean

    No

    Specifies whether to enable access over the public network.

    true
    Status

    string

    No

    The status of the gateway.

    Running
    ChargeType

    string

    No

    The billing method.

    Valid values:

    • PostPaid :

      Pay-as-you-go

    • PrePaid :

      Subscription

    PrePaid
    Sort

    string

    No

    The field to sort by.

    Valid values:

    • Status :

      Status

    • ChargeType :

      Billing method

    • CreateTime :

      Creation time

    • UpdateTime :

      Update time

    • InternetEnabled :

      Public network access

    • GatewayType :

      Gateway type

    • GatewayName :

      Gateway name

    CreateTime
    Order

    string

    No

    The sort order.

    Valid values:

    • asc :

      Ascending

    • desc :

      Descending

    asc
    GatewayType

    string

    No

    The type of the gateway.

    Valid values:

    • FullyManaged :

      Fully-managed dedicated gateway

    • Application :

      Application dedicated gateway

    Application
    Label

    object

    No

    Filter by tag.

    string

    No

    The tag to filter by, in {"key":"value"} format. You can set the value to null or an empty string to filter only by the key.

    {"key1":"value1","key2":null}

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned result.

    RequestId

    string

    The request ID.

    40325405-579C-4D82****
    Gateways

    array<object>

    The list of private gateways.

    array<object>

    The details of the private gateway.

    GatewayId

    string

    The ID of the private gateway.

    gw-1uhcqmsc7x22******
    GatewayName

    string

    The alias of the private gateway.

    mygateway1
    InstanceType

    string

    The instance type used by the private gateway.

    2c4g
    IntranetDomain

    string

    The internal network endpoint.

    gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com
    InternetEnabled

    boolean

    Indicates whether public network access is enabled.

    true
    InternetDomain

    string

    The public network endpoint.

    gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com
    CreateTime

    string

    The time when the private gateway was created. The time is in UTC.

    2020-05-19T14:19:42Z
    UpdateTime

    string

    The time when the private gateway was last updated. The time is in UTC.

    2021-02-24T11:52:17Z
    Status

    string

    The status of the private gateway.

    Valid values:

    • Creating :

      The gateway is being created.

    • Stopped :

      The gateway is stopped.

    • Failed :

      The gateway has failed.

    • Running :

      The gateway is running.

    • Deleted :

      The gateway is deleted.

    • Deleting :

      The gateway is being deleted.

    • Waiting :

      The gateway is waiting.

    Running
    Replicas

    integer

    The number of nodes for the private gateway.

    2
    IsDefault

    boolean

    Indicates whether it is the default private gateway.

    true
    ChargeType

    string

    The billing method. Valid values:

    • PrePaid: Subscription.

    • PostPaid: Pay-as-you-go.

    PostPaid
    SSLRedirectionEnabled

    boolean

    Indicates whether HTTP to HTTPS redirection is enabled.

    true
    IntranetEnabled

    boolean

    Indicates whether internal network access is enabled.

    Labels

    array<object>

    The list of gateway tags.

    object

    The gateway tag object.

    LabelKey

    string

    The key of the gateway tag.

    key1
    LabelValue

    string

    The value of the gateway tag.

    value1
    PageNumber

    integer

    The page number of the returned page.

    1
    PageSize

    integer

    The number of entries returned per page.

    100
    TotalCount

    integer

    The total number of gateways.

    5

    Examples

    Success response

    JSON format

    {
  "RequestId": "40325405-579C-4D82****",
  "Gateways": [
    {
      "GatewayId": "gw-1uhcqmsc7x22******",
      "GatewayName": "mygateway1",
      "InstanceType": "2c4g",
      "IntranetDomain": "gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com",
      "InternetEnabled": true,
      "InternetDomain": "gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com",
      "CreateTime": "2020-05-19T14:19:42Z",
      "UpdateTime": "2021-02-24T11:52:17Z",
      "Status": "Running",
      "Replicas": 2,
      "IsDefault": true,
      "ChargeType": "PostPaid",
      "SSLRedirectionEnabled": true,
      "IntranetEnabled": false,
      "Labels": [
        {
          "LabelKey": "key1",
          "LabelValue": "value1"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 5
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.