调用DescribeInstanceEndpoints查询RDS AI应用实例连接地址-云数据库 RDS-阿里云-云数据库 RDS(RDS)-阿里云帮助中心

该接口用于查询RDS AI应用实例连接地址信息。

接口说明

适用引擎

RDS PostgreSQL

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rdsai:DescribeInstanceEndpoints

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域。	cn-beijing
InstanceName	string	否	AI 应用的实例 ID。	ra-supabase-8moov5lxba****
BranchName	string	否	预留参数	预留参数

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求 ID。	32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C
InstanceName	string	AI 应用的实例 ID。	ra-supabase-8moov5lxba****
BranchName	string	预留参数	预留参数
InstanceEndpoints	array<object>	AI 应用实例的连接地址信息列表。
	object	AI 应用实例的连接地址信息列表。
ConnectionString	string	连接地址。	8.152.XXX.XXX:8000
IpType	string	网络类型。取值： public：外网。 vpc：私网。	public
IP	string	IP 地址。	8.152.XXX.XXX
Port	string	连接端口。	8000
Domain	string	域名地址。	xxx.apsaradb.com
DBInstanceEndpoints	array<object>	数据库实例的连接地址信息列表。
	object	数据库实例的连接地址信息列表。
ConnectionString	string	连接地址。	pgm-xxxx.rds.aliyuncs.com
IpType	string	网络类型。取值： public：外网。 vpc：私网。	vpc
Port	string	连接端口。	5432

示例

正常返回示例

JSON格式

{
  "RequestId": "32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\n",
  "InstanceName": "ra-supabase-8moov5lxba****",
  "BranchName": "预留参数",
  "InstanceEndpoints": [
    {
      "ConnectionString": "8.152.XXX.XXX:8000",
      "IpType": "public",
      "IP": "8.152.XXX.XXX",
      "Port": "8000",
      "Domain": "xxx.apsaradb.com"
    }
  ],
  "DBInstanceEndpoints": [
    {
      "ConnectionString": "pgm-xxxx.rds.aliyuncs.com",
      "IpType": "vpc",
      "Port": "5432"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IncorrectInstanceState	Current instance status does not support this operation.	当前实例状态不支持该操作
400	InvalidGroupName	Specified group name is not valid.	分组名称无效
400	InvalidParameter	The provided parameter is invalid.	无效的参数。
400	MasterInstanceNotExist	Master instance does not exist.	主实例不存在。
403	InsufficientResourceCapacity	There is not enough host resource inventory.	资源不足

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

变更历史

更多信息，参考变更详情。

DescribeInstanceEndpoints - 查询RDS AI应用实例连接地址信息