GetSupabaseProject-阿里云帮助中心

Retrieves details of a Supabase instance.

Operation description

Gets the details of a Supabase instance.

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:GetSupabaseProject

get

*SupabaseProject

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Note You can call the DescribeRegions operation to view the available region IDs.	cn-hangzhou
ProjectId	string	Yes	The Supabase instance ID. You can find this ID on the Supabase page in the console.	sbp-263****

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D****
ProjectName	string	The Supabase project name.	supabase_project
ProjectSpec	string	The Supabase instance specification.	1C1G
Status	string	The Supabase instance status.	running
PublicConnectUrl	string	The public connection URL for the Supabase Dashboard.	10.154.11.10
PrivateConnectUrl	string	The private connection URL for the Supabase Dashboard.	192.168.0.11
RegionId	string	The region ID. Note You can call the DescribeRegions operation to query the available regions.	cn-hangzhou
ZoneId	string	The zone ID. Note You can call the DescribeRegions operation to query the available zones.	cn-hangzhou-i
VpcId	string	The VPC ID. Note You can call the DescribeRdsVpcs operation to query the available VPCs. This parameter is required.	vpc-bp*******************
VSwitchId	string	The vSwitch ID.	vsw-bp1cpq8mr64paltkb****
SecurityIpList	string	The IP address whitelist, specified as a comma-separated string.	127.0.0.1
DiskPerformanceLevel	string	The performance level (PL) of the cloud disk. Valid values: PL0 PL1	PL0
Engine	string	The database engine.	postgres
EngineVersion	string	The engine version.	15
StorageSize	integer	The storage space, in GB.	2
CreateTime	string	The creation time of the project.	2019-09-08T16:00:00Z
DashboardUserName	string	The username for the Supabase Dashboard. This parameter is not used.	username
ProjectId	string	The Supabase project ID.	sbp-545434
DashboardPassword	string	The password for the Supabase Dashboard. This parameter is not used.	xxpassword
PayType	string	The billing method. Valid values: `POSTPAY`: pay-as-you-go `PREPAY`: subscription	POSTPAY
InstanceVersion	string	The current instance version.	v1.0.3
StorageType	string	The storage type. Valid values: cloud_essd_pl0 cloud_essd_pl1 cloud_essd_pl2 cloud_essd_pl3	cloud_essd_pl0
Eni	string	The elastic network interface (ENI) ID.	eni-xxxxxx
DBSecurityIpList	string	The database IP address whitelist, specified as a comma-separated string.	127.0.0.1,100.64.XX.XX/10
AutoScale	string	Indicates whether the auto pause and resume feature is enabled. Valid values: `true`: The feature is enabled. The project automatically pauses and resumes based on traffic. `false`: The feature is disabled. Valid values: true : true false : false	false
ProjectDescription	string	The description of the Supabase project.	for-test-project

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****",
  "ProjectName": "supabase_project",
  "ProjectSpec": "1C1G",
  "Status": "running",
  "PublicConnectUrl": "10.154.11.10",
  "PrivateConnectUrl": "192.168.0.11",
  "RegionId": "cn-hangzhou",
  "ZoneId": "cn-hangzhou-i",
  "VpcId": "vpc-bp*******************",
  "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
  "SecurityIpList": "127.0.0.1",
  "DiskPerformanceLevel": "PL0",
  "Engine": "postgres",
  "EngineVersion": "15",
  "StorageSize": 2,
  "CreateTime": "2019-09-08T16:00:00Z",
  "DashboardUserName": "username",
  "ProjectId": "sbp-545434",
  "DashboardPassword": "xxpassword",
  "PayType": "POSTPAY",
  "InstanceVersion": "v1.0.3",
  "StorageType": "cloud_essd_pl0",
  "Eni": "eni-xxxxxx",
  "DBSecurityIpList": "127.0.0.1,100.64.XX.XX/10",
  "AutoScale": "false",
  "ProjectDescription": "for-test-project"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.