DescribeGatewayAttribute

Viewing gateway instance details

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
GwClusterId	string	Yes	The ID of the gateway instance.	pg-xxxxxxx
RegionId	string	No	The ID of the region.	cn-beijing

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
VpcId	string	The ID of the VPC where the gateway instance is deployed.	vpc-*************
VSwitchId	string	The ID of the VSwitch where the gateway instance is deployed.	vsw-*********************
PayType	string	The billing method of the gateway instance. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
GwClusterId	string	The ID of the gateway instance.	pg-xxxxxxx
GwDescription	string	The description of the gateway instance.	xxx
Status	string	The status of the gateway instance. Valid values: CREATE: The gateway instance is being created. ACTIVATION: The gateway instance is running.	ACTIVATION
RegionId	string	The ID of the region.	cn-beijing
DbType	string	The database type.	MySQL
CreateTime	string	The time when the gateway instance was created.	2020-02-24T11:57:54Z
ModifyTime	string	The time when the gateway instance was last modified.	2025-10-07T02:19:55Z
ClassCode	string	The specification code for the gateway instance.	polar.app.g2.medium
ExpireTime	string	The time when the subscription for the gateway instance expires. This parameter is empty for pay-as-you-go instances.	2027-04-22T16:00:00Z
Endpoints	array<object>	A list of endpoints for the gateway instance.
	object	Contains the details of an endpoint.
Address	string	The endpoint address.	pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com
EndpointId	string	The ID of the endpoint.	xxx
GwClusterId	string	The ID of the gateway instance.	pg-xxxxxxx
Port	string	The port number.	8080
TunnelId	string	The tunnel ID.	1874631
VpcId	string	The ID of the VPC to which the endpoint belongs.	vpc-*************
NetType	string	The network type of the endpoint. Valid values: Private: VPC endpoint. Public: public endpoint.	Public
Expired	boolean	Indicates whether the subscription for the gateway instance has expired. Valid values: true false	False
SecurityIPArrays	array<object>	A list of IP whitelists for the gateway instance.
	object	Contains the details of an IP whitelist.
SecurityIPArrayTag	string	The tag of the IP whitelist.	mytag
SecurityIPList	string	A comma-separated list of IP addresses in the IP whitelist.	127.0.0.1
SecurityIPArrayName	string	The name of the IP whitelist. The default value is `default`.	default
LatestVersion	string
CurrentVersion	string
RunningVersion	string

Examples

Success response

JSON format

{
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "VpcId": "vpc-*************",
  "VSwitchId": "vsw-*********************",
  "PayType": "Postpaid",
  "GwClusterId": "pg-xxxxxxx",
  "GwDescription": "xxx",
  "Status": "ACTIVATION",
  "RegionId": "cn-beijing",
  "DbType": "MySQL",
  "CreateTime": "2020-02-24T11:57:54Z",
  "ModifyTime": "2025-10-07T02:19:55Z",
  "ClassCode": "polar.app.g2.medium",
  "ExpireTime": "2027-04-22T16:00:00Z",
  "Endpoints": [
    {
      "Address": "pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com",
      "EndpointId": "xxx",
      "GwClusterId": "pg-xxxxxxx",
      "Port": "8080",
      "TunnelId": "1874631",
      "VpcId": "vpc-*************",
      "NetType": "Public"
    }
  ],
  "Expired": true,
  "SecurityIPArrays": [
    {
      "SecurityIPArrayTag": "mytag",
      "SecurityIPList": "127.0.0.1",
      "SecurityIPArrayName": "default"
    }
  ],
  "LatestVersion": "",
  "CurrentVersion": "",
  "RunningVersion": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.