调用DescribeAppInstances接口查询RDS AI应用实例列表-云数据库 RDS-阿里云-云数据库 RDS(RDS)-阿里云帮助中心

该接口用于查询RDS AI应用实例列表。

接口说明

适用引擎

RDS PostgreSQL

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

rdsai:DescribeAppInstances

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域。	cn-beijing
DBInstanceName	string	否	AI 应用接入的 RDS PostgreSQL 数据库实例 ID。传入该参数后查询指定 RDS PostgreSQL 实例关联的 AI 应用实例。	pgm-2ze49qv594vi****
AppType	string	否	应用类型。当前仅支持 supabase，表示RDS Supabase。	supabase
PageSize	integer	否	每页记录数。取值：1~50。	10
PageNumber	integer	否	页码。取值：大于 0 且不超过 Integer 的最大值。	1

返回参数

名称	类型	描述	示例值
	object	返回参数详情。
RequestId	string	请求 ID。	32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C
TotalCount	integer	总记录数。	20
MaxResults	integer	备用参数，无需关注。	None
PageNumber	integer	页码。	1
PageSize	integer	每页记录数。	10
Instances	array<object>	实例列表。
	array<object>	实例列表。
InstanceName	string	AI 应用的实例 ID。	ra-supabase-8moov5lxba****
AppType	string	应用类型。当前仅支持 supabase，表示RDS Supabase。	supabase
InstanceMinorVersion	string	AI 应用实例的小版本。	20241231
VSwitchId	string	交换机 ID。	vsw-2zeaepb8k4ku05ov2****
InstanceClass	string	实例规格。	rdsai.supabase.basic
Status	string	实例状态。详情请参见实例状态表。	Running
DBInstanceName	string	AI 应用接入的 RDS PostgreSQL 数据库实例 ID。	pgm-2ze49qv594vi****
RegionId	string	地域 ID。	cn-beijing
AppName	string	AI 应用的名称。	test-supabase
PublicConnectionString	string	AI 应用的外网连接地址。	8.152. XXX.XXX:8000
VpcConnectionString	string	AI 应用的内网连接地址。	172.16.XXX.XXX:8000
Components	array<object>	模块列表
	object	模块列表
Type	string	模块类型
Status	string	模块状态

示例

正常返回示例

JSON格式

{
  "RequestId": "32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C",
  "TotalCount": 20,
  "MaxResults": 0,
  "PageNumber": 1,
  "PageSize": 10,
  "Instances": [
    {
      "InstanceName": "ra-supabase-8moov5lxba****\n",
      "AppType": "supabase",
      "InstanceMinorVersion": "20241231",
      "VSwitchId": "vsw-2zeaepb8k4ku05ov2****",
      "InstanceClass": "rdsai.supabase.basic",
      "Status": "Running",
      "DBInstanceName": "pgm-2ze49qv594vi****",
      "RegionId": "cn-beijing",
      "AppName": "test-supabase",
      "PublicConnectionString": "8.152. XXX.XXX:8000",
      "VpcConnectionString": "172.16.XXX.XXX:8000",
      "Components": [
        {
          "Type": "",
          "Status": ""
        }
      ]
    }
  ]
}

错误码

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.	资源不足

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

变更历史

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

DescribeAppInstances - 查询RDS AI应用实例列表