ListSupabaseProjects - AnalyticDB - Alibaba Cloud Documentation Center

Retrieves a paginated list of Supabase instances in your account. You can filter the list by region.

Operation description

You can call this operation to query Supabase instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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
gpdb:ListSupabaseProjects	list	SupabaseProject `acs:gpdb:{#regionId}:{#accountId}:supabaseproject/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the cluster. Note You can call the DescribeRegions operation get a list of available region IDs.	cn-hangzhou
NextToken	string	No	A pagination token returned from a previous call. Use it to retrieve the next page of results.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	No	The maximum number of instances to return per page. Default value: 10.	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	ABB39CC3-4488-4857-905D-2E4A051D****
PageNumber	integer	The page number of the returned page.	1
PageRecordCount	integer	The number of entries per page.	20
TotalRecordCount	integer	The total number of log entries returned.	2
Items	array<object>	A list of objects, where each object represents a Supabase instance.
items	object	The instance details.
Status	string	The status of the Supabase instance.	running
PublicConnectUrl	string	The public connection URL for the Supabase Dashboard.	10.154.11.10
DashboardUserName	string	Supabase Dashboard user name (not used).	null
EngineVersion	string	The database 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 of the instance.	vsw-bp1cpq8mr64paltkb****
CreateTime	string	The creation time.	2021-10-09T04:54:08Z
ProjectId	string	The Supabase project ID.	sbp-12***
DiskPerformanceLevel	string	The ESSD performance level.	PL0
StorageSize	long	The storage capacity of the instance. Unit: GB.	2
PayType	string	The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription. Free: Free.	Postpaid
PrivateConnectUrl	string	The private (VPC) connection URL for the Supabase Dashboard.	192.168.0.1
ProjectSpec	string	The type of the Supabase instance.	1C1G
VpcId	string	The VPC ID.	vpc-bp19ame5m1r3oejns****
SecurityIPList	string	A comma-separated list of IP addresses and CIDR blocks allowed to connect. Valid values: 0.0.0.0/0 10.23.12.24(IP) 10.23.12.24/24. This is a CIDR block. The value`/24`indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of`[1,32]`.	127.0.0.1
DashboardPassword	string	Supabase Dashboard password (not used).	xxpassword
RegionId	string	The region ID.	cn-hangzhou
Engine	string	The database engine type.	gpdb
NextToken	string	The pagination token to use in the next request to get the next page. If this field is empty, there are no more results.	caeba0bbb2be03f84eb48b699f0a****
MaxResults	integer	The maximum amount of data to read this time. Default value: 10.	50

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.