Queries a list of Supabase instances.
Operation description
Queries the list of custom endpoints configured by the user for managing and viewing private connection or VPC endpoint service settings.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. |
cn-hangzhou |
| PageNumber |
integer |
No |
The page number. Minimum value: 1. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Default value: 20. Maximum value: 100. |
30 |
| DBInstanceName |
string |
No |
The instance name. This parameter is used for exact match filtering. Separate multiple instance names with commas (,). |
pxsp-hz******** |
| Description |
string |
No |
The instance description. This parameter supports fuzzy match. |
project name |
| MaxResults |
integer |
No |
The maximum number of entries per page for a paged query. Maximum value: 100. Default value: If you do not specify this parameter or specify a value less than 10, the default value is 10. If you specify a value greater than 100, the default value is 100. |
1000 |
| NextToken |
string |
No |
The token for the next query. |
xxdds |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| RequestId |
string |
The request ID. |
C457B28E-9CAB-4B77-B5C6-5D71B7870B6E |
| Data |
object |
The paginated result of the instance list. |
|
| TotalNumber |
integer |
The total number of entries. |
10 |
| PageNumber |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries per page. |
20 |
| Instances |
array<object> |
The list of instances. |
|
|
object |
The cluster ID. |
||
| DBInstanceName |
string |
pxsp-jinwusp30 |
|
| Description |
string |
我的 Supabase 项目 |
|
| Status |
string |
RUNNING |
|
| RegionId |
string |
cn-beijing |
|
| ZoneId |
string |
cn-beijing-i |
|
| CreateTime |
string |
2026-06-08T07:19:05.000+0000 |
|
| SupabaseClassCode |
string |
polarx.supabase.x4.2xlarge |
|
| TenantMode |
boolean |
是否为多租户模式，true=多租户，false=单租户 |
MySQL |
| AccessDeniedDetail |
object |
The details of the access denial. |
|
| AuthAction |
string |
The authentication action. |
xxx |
| AuthPrincipalType |
string |
The authentication principal type. |
222 |
| NoPermissionType |
string |
The type of the permission denial. |
ImplicitDeny |
| PolicyType |
string |
The policy type. |
System |
| EncodedDiagnosticMessage |
string |
The encoded diagnostic message. |
AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA== |
| AuthPrincipalOwnerId |
string |
The owner ID of the authentication principal. |
111 |
| AuthPrincipalDisplayName |
string |
The display name of the authentication principal. |
xxx |
| MaxResults |
integer |
The maximum number of entries per page for a paged query. Maximum value: 100. Default value: If you do not specify this parameter or specify a value less than 10, the default value is 10. If you specify a value greater than 100, the default value is 100. |
1000 |
| NextToken |
string |
The token for the next query. |
xxdds |
Examples
Success response
JSON format
{
"RequestId": "C457B28E-9CAB-4B77-B5C6-5D71B7870B6E",
"Data": {
"TotalNumber": 10,
"PageNumber": 1,
"PageSize": 20,
"Instances": [
{
"DBInstanceName": "pxsp-jinwusp30",
"Description": "我的 Supabase 项目",
"Status": "RUNNING",
"RegionId": "cn-beijing",
"ZoneId": "cn-beijing-i",
"CreateTime": "2026-06-08T07:19:05.000+0000",
"SupabaseClassCode": "polarx.supabase.x4.2xlarge",
"TenantMode": true
}
]
},
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "System",
"EncodedDiagnosticMessage": "AQEAAAAAacnceTlBNjlFODgyLTlBMDUtNUUyRC04MzE5LUQwMzZDRjJFQTM3NA==",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx"
},
"MaxResults": 1000,
"NextToken": "xxdds"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.