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

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

接口说明

适用引擎

RDS PostgreSQL

相关功能文档

RDS Supabase

调试

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

授权信息

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

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

请求参数

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

地域。

cn-beijing
InstanceNamestring

AI 应用的实例 ID。

ra-supabase-8moov5lxba****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C
InstanceNamestring

AI 应用的实例 ID。

ra-supabase-8moov5lxba****
InstanceEndpointsarray<object>

AI 应用实例的连接地址信息列表。

instanceEndpointsobject
IpTypestring

网络类型。取值:

  • public:外网。
  • vpc:私网。
public
IPstring

IP 地址。

8.152.XXX.XXX
Portstring

连接端口。

8000
ConnectionStringstring

连接地址。

8.152.XXX.XXX:8000

示例

正常返回示例

JSON格式

{
  "RequestId": "32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C\n",
  "InstanceName": "ra-supabase-8moov5lxba****",
  "InstanceEndpoints": [
    {
      "IpType": "public",
      "IP": "8.152.XXX.XXX",
      "Port": 8000,
      "ConnectionString": "8.152.XXX.XXX:8000"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IncorrectInstanceStateCurrent instance status does not support this operation.当前实例状态不支持该操作
400InvalidGroupNameSpecified group name is not valid.分组名称无效
400InvalidParameterThe provided parameter is invalid.无效的参数。
400MasterInstanceNotExistMaster instance does not exist.主实例不存在。
403InsufficientResourceCapacityThere is not enough host resource inventory.资源不足

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