DescribeAppInstances-阿里云帮助中心

This API retrieves a list of RDS AI application instances.

Operation description

Supported engines

RDS PostgreSQL

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

rdsai:DescribeAppInstances

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
DBInstanceName	string	No	The ID of an RDS PostgreSQL instance to return only the associated AI application instances.	pgm-2ze49qv594vi****
AppType	string	No	The application type. The only supported value is supabase, which indicates RDS Supabase.	supabase
PageSize	integer	No	The number of AI application instances to return on each page. Valid values: 1 to 50.	10
PageNumber	integer	No	The page number of the results to return. The value must be greater than 0.	1

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	32DEFB4A-861F-5D1D-ADD5-918E4FD7AB8C
TotalCount	integer	The total number of entries returned.	20
MaxResults	integer	This parameter is reserved for future use.	None
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Instances	array<object>	A list of instances.
	array<object>	Details of an instance.
InstanceName	string	The ID of the application instance.	ra-supabase-8moov5lxba****
AppType	string	The application type. The only supported value is supabase, which represents RDS Supabase.	supabase
InstanceMinorVersion	string	The minor version of the AI application.	20241231
VSwitchId	string	The VSwitch ID.	vsw-2zeaepb8k4ku05ov2****
InstanceClass	string	The instance type.	rdsai.supabase.basic
Status	string	The instance status. For more information, see Instance status table.	Running
DBInstanceName	string	The DB instance ID of the connected ApsaraDB RDS for PostgreSQL instance.	pgm-2ze49qv594vi****
RegionId	string	The region ID.	cn-beijing
AppName	string	The application name.	test-supabase
PublicConnectionString	string	The public connection string.	8.152. XXX.XXX:8000
VpcConnectionString	string	The VPC connection string.	172.16.XXX.XXX:8000
Components	array<object>	The components of the instance.
	object	Details of a component.
Type	string	The component type.
Status	string	The component status.

Examples

Success response

JSON format

{
  "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": ""
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectInstanceState	Current instance status does not support this operation.	The operation is not supported in the current instance state.
400	InvalidGroupName	Specified group name is not valid.	Invalid group name
400	InvalidParameter	The provided parameter is invalid.	Invalid parameter.
400	MasterInstanceNotExist	Master instance does not exist.	The primary instance does not exist.
403	InsufficientResourceCapacity	There is not enough host resource inventory.	Insufficient resources

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.