All Products
Search

This Product

    Platform For AI:DescribeGateway

    Document Center

    Platform For AI:DescribeGateway

    Last Updated:Dec 23, 2025

    Queries the details of a private gateway.

    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:DescribeGateway

    get

    *Gateway

    acs:eas:{#regionId}:{#accountId}:gateway/{#GatewayId}

    		 None None

    Request syntax

    GET /api/v2/gateways/{ClusterId}/{GatewayId} HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    ClusterId

    string

    Yes

    The region where the private gateway is located.

    cn-wulanchabu
    GatewayId

    string

    Yes

    The ID of the private gateway. To obtain the ID, check the private_gateway_id field in the response of the ListResources operation.

    gw-1uhcqmsc7x22******

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    No parameters required.

    Response elements

    Element

    Type

    Description

    Example

    object

    The response.

    RequestId

    string

    The request ID.

    40325405-579C-4D82****
    GatewayId

    string

    The ID of the private gateway.

    gw-1uhcqmsc7x22******
    GatewayName

    string

    The alias of the private gateway.

    mygateway1
    CreateTime

    string

    The time when the private gateway was created. The time is in Coordinated Universal Time (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
    IntranetDomain

    string

    The private 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 endpoint.

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

    string

    The instance type of the private gateway.

    Valid values:

    • 8c16g :

      8c16g

    • 4c8g :

      4c8g

    • 2c4g :

      2c4g

    • 16c32g :

      16c32g

    2c4g
    Status

    string

    The status of the private gateway.

    Valid values:

    • Creating :

      Creating

    • Stopped :

      Stopped

    • Failed :

      Failed

    • Running :

      Running

    • Deleted :

      Deleted

    • Deleting :

      Deleting

    • Waiting :

      Waiting

    Running
    ExternalClusterId

    string

    The ID of the self-managed cluster.

    c935eadf284c14c2da57a2a13ad6******
    Replicas

    integer

    The number of private gateway nodes.

    2
    IsDefault

    boolean

    Indicates whether the gateway is the default private gateway.

    true
    InternetStatus

    string

    The status of public network access.

    Valid values:

    • Creating :

      Enabling

    • Failed :

      Failed to enable or delete

    • Running :

      Enabled

    • Deleted :

      Deleted

    • Deleting :

      Deleting

    Running
    SSLRedirectionEnabled

    boolean

    Indicates whether HTTP to HTTPS redirection is enabled.

    true
    ChargeType

    string

    The billing method.

    Valid values:

    • PrePaid（预付费） :

      subscription

    • PostPaid（后付费） :

      pay-as-you-go

    PrePaid
    IntranetEnabled

    boolean

    Labels

    array<object>

    object

    LabelKey

    string

    key1
    LabelValue

    string

    value1

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.