文档

DescribeDBInstanceNetInfo - 查看实例的连接地址信息

更新时间:

查询实例的连接信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:DescribeDBInstanceNetInfoRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

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

数据库连接地址。

说明 如果不指定该参数,将会返回所有数据库连接地址的相关信息。
gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

7565770E-7C45-462D-BA4A-8A5396F2CAD1
DBInstanceNetInfosobject []

实例的连接信息。

VSwitchIdstring

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

vsw-0xi4kt4dho2kx79p1****
ConnectionStringstring

数据库连接 URL。

gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com
IPTypestring

IP 类型。

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

端口信息。

3432
VpcInstanceIdstring

VPC 实例 ID。

vpc-0xi8hbevlbj3bq0co****
VPCIdstring

VPC ID。

vpc-0xi8hbevlbj3bq0co****
IPAddressstring

IP 地址。

127.0.0.1
AddressTypestring

地址类型。

Primary
InstanceNetworkTypestring

实例网络类型:

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

示例

正常返回示例

JSON格式

{
  "RequestId": "7565770E-7C45-462D-BA4A-8A5396F2CAD1",
  "DBInstanceNetInfos": {
    "DBInstanceNetInfo": [
      {
        "VSwitchId": "vsw-0xi4kt4dho2kx79p1****",
        "ConnectionString": "gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com",
        "IPType": "Inner",
        "Port": "3432",
        "VpcInstanceId": "vpc-0xi8hbevlbj3bq0co****",
        "VPCId": "vpc-0xi8hbevlbj3bq0co****",
        "IPAddress": "127.0.0.1",
        "AddressType": "Primary"
      }
    ]
  },
  "InstanceNetworkType": "VPC"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-31OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ConnectionString
  • 本页导读 (1)
文档反馈