ListSupabaseProjects-阿里云帮助中心

Returns a list of Supabase instances.

Operation description

Lists Supabase instances.

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

gpdb:ListSupabaseProjects

list

*SupabaseProject

acs:gpdb:{#regionId}:{#accountId}:supabaseproject/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region. Note You can call the DescribeRegions operation to query the available regions.	cn-hangzhou
NextToken	string	No	The pagination token to retrieve the next page of results.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The maximum number of entries to return. The default value is 10.	20
PageSize	integer	No	The number of entries per page.	30
PageNumber	integer	No	The page number.	1
SearchField	string	No		ProjectId
SearchValue	string	No		gp-bp***************
SortField	string	No		UpdatedDate
SortOrder	string	No		desc

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D****
PageNumber	integer	The page number.	1
PageRecordCount	integer	The number of entries on the current page.	20
TotalRecordCount	integer	The total number of entries.	2
Items	array<object>	A list of instance details.
	object	Details of the instance.
Status	string	The status of the instance.	running
PublicConnectUrl	string	The public endpoint for the Supabase dashboard.	10.154.11.10
EngineVersion	string	The engine version.	6.0
ZoneId	string	The zone ID.	cn-hangzhou-h
ProjectName	string	The name of the Supabase project.	supabase_project
VSwitchId	string	The vSwitch ID.	vsw-bp1cpq8mr64paltkb****
ProjectId	string	The ID of the Supabase instance.	sbp-12***
DiskPerformanceLevel	string	The disk performance level.	PL0
StorageSize	integer	The storage size in GB.	2
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription. Free: The instance is free of charge.	Postpaid
PrivateConnectUrl	string	The private endpoint for the Supabase dashboard.	192.168.0.1
ProjectSpec	string	The Supabase instance specification.	1C1G
VpcId	string	The VPC ID.	vpc-bp19ame5m1r3oejns****
SecurityIPList	string	The IP whitelist. IP addresses are separated by commas. The following formats are supported: 0.0.0.0/0 10.23.12.24 (IP) 10.23.12.24/24 (a Classless Inter-Domain Routing (CIDR) block; the prefix length, which is the number after the `/`, must be an integer from 1 to 32.)	127.0.0.1
RegionId	string	The region ID.	cn-hangzhou
Engine	string	The database engine.	gpdb
CreateTime	string	The time when the resource was created.	2021-10-09T04:54:08Z
DashboardPassword	string	The password for the Supabase dashboard. This parameter is reserved.	xxpassword
DashboardUserName	string	The username for the Supabase dashboard. This parameter is reserved.	null
ExpireTime	string	The expiration time.	2026-04-27T16:00:00Z
AutoScale	string	Indicates if the auto start and stop feature is enabled. Valid values: `true`: The feature is enabled. The Supabase instance automatically pauses and resumes based on traffic. `false`: The auto start and stop feature is disabled. Valid values: true : true false : false	false
ProjectDescription	string	The detailed description of the Supabase project.
NextToken	string	A pagination token for retrieving the next page of results. If this parameter is not returned, it indicates that all results have been displayed.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	The maximum number of entries returned per page.	50

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****",
  "PageNumber": 1,
  "PageRecordCount": 20,
  "TotalRecordCount": 2,
  "Items": [
    {
      "Status": "running",
      "PublicConnectUrl": "10.154.11.10",
      "EngineVersion": "6.0",
      "ZoneId": "cn-hangzhou-h",
      "ProjectName": "supabase_project",
      "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
      "ProjectId": "sbp-12***",
      "DiskPerformanceLevel": "PL0",
      "StorageSize": 2,
      "PayType": "Postpaid",
      "PrivateConnectUrl": "192.168.0.1",
      "ProjectSpec": "1C1G",
      "VpcId": "vpc-bp19ame5m1r3oejns****",
      "SecurityIPList": "127.0.0.1",
      "RegionId": "cn-hangzhou",
      "Engine": "gpdb",
      "CreateTime": "2021-10-09T04:54:08Z",
      "DashboardPassword": "xxpassword",
      "DashboardUserName": "null",
      "ExpireTime": "2026-04-27T16:00:00Z",
      "AutoScale": "false",
      "ProjectDescription": ""
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "MaxResults": 50
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.