查询网关实例详情
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| GwClusterId |
string |
是 |
网关实例 ID。 |
pg-xxxxxxx |
| RegionId |
string |
否 |
地域 ID。 |
cn-beijing |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF |
| VpcId |
string |
交换机所属专有网络 ID。 |
vpc-************* |
| VSwitchId |
string |
虚拟交换机 ID。 |
vsw-********************* |
| PayType |
string |
付费类型。取值范围如下：
|
Postpaid |
| GwClusterId |
string |
网关实例 ID。 |
pg-xxxxxxx |
| GwDescription |
string |
网关描述 |
xxx |
| Status |
string |
应用状态，取值范围
|
ACTIVATION |
| RegionId |
string |
地域 ID。 |
cn-beijing |
| DbType |
string |
数据库类型。 |
MySQL |
| CreateTime |
string |
创建时间 |
2020-02-24T11:57:54Z |
| ModifyTime |
string |
最后修改时间。 |
2025-10-07T02:19:55Z |
| ClassCode |
string |
规格代码。 |
polar.app.g2.medium |
| ExpireTime |
string |
过期时间。 付费类型为 Postpaid 时为空 |
2027-04-22T16:00:00Z |
| Endpoints |
array<object> |
连接地址列表 |
|
|
object |
连接地址对象 |
||
| Address |
string |
连接地址 |
pg-xxxxx.polardbaigateway.pre.rds.aliyuncs.com |
| EndpointId |
string |
连接节点 ID。 |
xxx |
| GwClusterId |
string |
网关实例 ID。 |
pg-xxxxxxx |
| Port |
string |
端口 |
8080 |
| TunnelId |
string |
隧道 ID。 |
1874631 |
| VpcId |
string |
交换机所属专有网络 ID。 |
vpc-************* |
| NetType |
string |
连接地址类型
|
Public |
| Expired |
boolean |
是否集群已过期。取值范围如下：
|
False |
| SecurityIPArrays |
array<object> |
应用级别的白名单 |
|
|
object |
应用级别的白名单 |
||
| SecurityIPArrayTag |
string |
IP 地址组的标签 |
mytag |
| SecurityIPList |
string |
白名单 IP 地址，英文逗号分隔 |
127.0.0.1 |
| SecurityIPArrayName |
string |
该 IP 地址组的名称，默认为 |
default |
| LatestVersion |
string |
||
| CurrentVersion |
string |
||
| RunningVersion |
string |
示例
正常返回示例
JSON格式
{
"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": ""
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。