Queries the RDS Supabase instances.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| rdsai:DescribeAppInstances | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | No | The operation that you want to perform. Set the value to DescribeAppInstances. | cn-beijing |
| DBInstanceName | string | No | The region ID. | pgm-2ze49qv594vi**** |
| AppType | string | No | The ID of the RDS for PostgreSQL instance with which the RDS Supabase instances are associated. If you specify this parameter, the RDS Supabase instances associated with the specified RDS for PostgreSQL instance are queried. | supabase |
| PageSize | long | No | The application type. Only supabase is supported. For more information, see RDS Supabase. | 10 |
| PageNumber | long | No | The number of records per page. Valid values: 1 to 50. | 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"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"
}
]
}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 |
For a list of error codes, visit the Service error codes.