调用DescribeDBInstanceNetInfo查询实例的连接信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBInstanceNetInfo

系统规定参数。取值:DescribeDBInstanceNetInfo

DBInstanceId String gp-xxxxxxxxxx

实例ID。

说明 您可以调用 DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情,包括实例ID。

返回数据

名称 类型 示例值 描述
RequestId String 7565770E-7C45-462D-BA4A-8A5396F2CAD1

请求ID。

DBInstanceNetInfos Array of DBInstanceNetInfo

实例的连接信息。

DBInstanceNetInfo
VSwitchId String vsw-xxxxxxxx

vSwitch ID,多个值用英文逗号(,)隔开。

ConnectionString String gp-xxxxxxx.gpdb.rds.aliyuncs.com

数据库连接URL。

IPType String Inner

IP类型。

  • 经典网络类型的实例IPType为:Inner、Public。
  • VPC类型的实例IPType为:Private、Public。
Port String 3432

端口信息。

VpcInstanceId String vpc-xxxxxxx

VPC实例ID。

VPCId String vpc-xxxxxxx

VPC ID。

IPAddress String 127.0.0.1

IP地址。

AddressType String Intranet

地址类型。

InstanceNetworkType String Classic

实例网络类型:

  • Classic:经典网络。
  • VPC:VPC网络。

示例

请求示例

https://gpdb.aliyuncs.com/?Action=DescribeDBInstanceNetInfo
&DBInstanceId=gp-xxxxxxxxxx
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstanceNetInfoResponse>
<instanceNetworkType>Classic</instanceNetworkType>
<DBInstanceNetInfos>
    <DBInstanceNetInfo>
        <DBInstanceNetType>1</DBInstanceNetType>
        <connectionString>gp-xxxxxxx.gpdb.rds.aliyuncs.com</connectionString>
        <ipAddress>127.0.0.1</ipAddress>
        <port>3432</port>
        <VPCId>vpc-xxxxxxxxx</VPCId>
        <VSwitchId>vsw-xxxxxxx</VSwitchId>
    </DBInstanceNetInfo>
</DBInstanceNetInfos>
<RequestId>7565770E-7C45-462D-BA4A-8A5396F2CAD1</RequestId>
</DescribeDBInstanceNetInfoResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "instanceNetworkType" : "Classic",
  "DBInstanceNetInfos" : {
    "DBInstanceNetInfo" : [ {
      "DBInstanceNetType" : "1",
      "connectionString" : "gp-xxxxxxx.gpdb.rds.aliyuncs.com",
      "ipAddress" : "127.0.0.1",
      "port" : "3432",
      "VPCId" : "vpc-xxxxxxxxx",
      "VSwitchId" : "vsw-xxxxxxx"
    } ]
  },
  "RequestId" : "7565770E-7C45-462D-BA4A-8A5396F2CAD1"
}

错误码

访问错误中心查看更多错误码。