CreateSupabaseProject - AnalyticDB - Alibaba Cloud Documentation Center

Creates a Supabase project.

Operation description

Creates a Supabase project in a specified region and zone. This operation supports Free, pay-as-you-go, and subscription billing methods. You can specify the network, specifications, storage, access IP address whitelist, DPI engine version, and auto start/stop configurations.

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

create

*SupabaseProject

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Specifies the region in which to create the project.	cn-hangzhou
ProjectName	string	Yes	The name of the Supabase project. Naming rules: The name must be 1 to 128 characters in length. The name can contain letters, digits, hyphens (-), and underscores (_). The name must start with a letter or an underscore (_).	saas_iot_x86_modbustcp_lqt01
ZoneId	string	Yes	The zone ID. The zone of the vSwitch specified by VSwitchId must be the same as the value of this parameter.	cn-hangzhou-h
AccountPassword	string	Yes	The password of the initial account. Password rules: The password must be 8 to 32 characters in length. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Supported special characters include !@#$%^&*()_+-=.	Pw123456
SecurityIPList	string	Yes	The IP address whitelist. Separate multiple IP addresses or CIDR blocks with commas (,). If this parameter is not specified, the default value 0.0.0.0/0 is used.	127.0.0.1
VpcId	string	Yes	The ID of the virtual private cloud (VPC). This parameter is required.	vpc-bp*******************
VSwitchId	string	Yes	The vSwitch ID. This parameter is required. The zone of the vSwitch must be the same as the value of ZoneId.	vsw-bp1cpq8mr64paltkb****
ProjectSpec	string	Yes	The specifications of the Supabase project. The Free billing type uses free-tier specifications. For paid billing types, the specifications must match those available on the console.	1C1G
StorageSize	integer	No	The storage size. Unit: GB. If this parameter is not specified for non-Free billing types, the default value is 1 GB.	2
DiskPerformanceLevel	string	No	The performance level (PL) of the cloud disk. If this parameter is not specified, the default value PL0 is used. Valid values: PL0 PL1 PL2 PL3.	PL0
ClientToken	string	No	The idempotency token. This token ensures that duplicate requests do not trigger the same operation more than once.	0c593ea1-3bea-11e9-b96b-88888888****
PayType	string	No	The billing method. If this parameter is not specified, the default value Free is used. Valid values: Free: free tier. Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
UsedTime	string	No	The subscription duration of the resource. This parameter takes effect only when PayType is set to PrePay. If this parameter is not specified, the default value is 1.	1
Period	string	No	The unit of the subscription duration. This parameter takes effect only when PayType is set to PrePay. If this parameter is not specified, the default value Month is used. Valid values: Month: month. Year: year.	Month
AutoScale	boolean	No	Specifies whether to enable auto start/stop. If this parameter is not specified, the default value is false.	false
EngineVersion	string	No	The DPI engine version. If this parameter is not specified, the default value PG15 is used. Valid values: PG15: PostgreSQL 15. PG17: PostgreSQL 17.	PG15

Response elements

Element	Type	Description	Example
	object	The response object.
ProjectId	string	The instance ID of the Supabase project.	sbp-180****
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D****
OrderId	string	The ID of the associated order.	278880417310796

Examples

Success response

JSON format

{
  "ProjectId": "sbp-180****",
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D****",
  "OrderId": "278880417310796"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.