CreateSupabaseProject

更新时间:
复制 MD 格式

Creates a Supabase project.

Operation description

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

create

*SupabaseProject

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

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID. You can call the DescribeRegions operation to query the available regions.

cn-hangzhou

ProjectName

string

Yes

The project name. The name must meet the following requirements:

  • It must be 1 to 128 characters in length.

  • It can contain only letters, digits, hyphens (-), and underscores (_).

  • It must start with a letter or an underscore (_).

saas_iot_x86_modbustcp_lqt01

ZoneId

string

Yes

The availability zone ID.

Note

You can call the DescribeRegions operation to query the available availability zones.

cn-hangzhou-h

AccountPassword

string

Yes

The password of the initial account. The password must meet the following requirements:

  • It must contain characters from at least three of the following categories: uppercase letters, lowercase letters, digits, and special characters.

  • Supported special characters: !@#$%^&*()_+-=

  • It must be 8 to 32 characters in length.

Pw123456

SecurityIPList

string

Yes

The IP address whitelist.

To block all external IP addresses from accessing the instance, set this parameter to 127.0.0.1. After the instance is created, you can call the ModifySecurityIps operation to modify the IP address whitelist.

127.0.0.1

VpcId

string

Yes

The VPC ID.

Note
  • You can call the DescribeRdsVpcs operation to query the available VPCs.

  • This parameter is required.

vpc-bp*******************

VSwitchId

string

Yes

The vSwitch ID.

Note
  • The VSwitchId parameter is required.

  • The vSwitch must be in the same availability zone as the one specified by the ZoneId parameter.

vsw-bp1cpq8mr64paltkb****

ProjectSpec

string

Yes

The specifications of the Supabase instance. The default specification for the free tier is 1C1G. For paid tiers, the available specifications are subject to what is displayed on the console.

1C1G

StorageSize

integer

No

The storage capacity. Unit: GB. Default value: 1.

2

DiskPerformanceLevel

string

No

The performance level of the cloud disk. Default value: PL0. Valid values:

  • PL0

  • PL1

PL0

ClientToken

string

No

The client token that is used to ensure the idempotence of the request. For more information, see How to ensure idempotence.

0c593ea1-3bea-11e9-b96b-88888888****

PayType

string

No

The billing method. Valid values:

  • Postpaid: pay-as-you-go.

  • Prepaid: subscription.

Note
  • If you do not specify this parameter, a free-tier instance is created by default.

  • Discounts are available for subscriptions of one year or longer.

Postpaid

UsedTime

string

No

The subscription duration. Valid values:

  • If Period is set to Month, the valid values are 1 to 11.

  • If Period is set to Year, the valid values are 1 to 3.

Note

This parameter is required if you use the subscription billing method.

1

Period

string

No

The unit of the subscription duration. Valid values:

  • Month

  • Year

Note

This parameter is required if you use the subscription billing method.

Month

Response elements

Element

Type

Description

Example

object

The response object.

ProjectId

string

The ID of the Supabase instance.

sbp-180****

RequestId

string

The request ID.

ABB39CC3-4488-4857-905D-2E4A051D****

OrderId

string

The order ID.

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.