CreateSupabaseProject - 创建 Supabase 项目

更新时间:
复制 MD 格式

创建 Supabase 项目。

接口说明

该接口用于在指定地域和可用区创建 Supabase 项目。支持免费、按量付费和包年包月计费方式,并可指定网络、规格、存储、访问白名单、引擎版本和自动启停配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:CreateSupabaseProject

create

*SupabaseProject

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

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

否

地域 ID。用于限定查询或操作所在地域。

cn-hangzhou

ProjectName

string

是

Supabase 项目名称。

命名规则:

  • 长度为 1~128 个字符。

  • 只能包含英文字母、数字、短划线(-)和下划线(_)。

  • 必须以英文字母或下划线(_)开头。

supabase_demo

ZoneId

string

是

可用区 ID。VSwitchId 所在可用区需要与该参数一致。

cn-hangzhou-i

AccountPassword

string

是

初始账号密码。

密码规则:

  • 长度为 8~32 个字符。

  • 至少包含大写字母、小写字母、数字、特殊字符中的三类。

  • 支持的特殊字符包括 !@#$%^&*()_+-=。

TestPassword123!

SecurityIPList

string

是

IP 白名单。多个 IP 或网段使用英文逗号分隔;不传时默认值为 0.0.0.0/0。

0.0.0.0/0

VpcId

string

是

专有网络 VPC ID。该参数必填。

vpc-bp1234567890

VSwitchId

string

是

交换机 ID。该参数必填,且交换机所在可用区需要与 ZoneId 一致。

vsw-bp1234567890

ProjectSpec

string

是

Supabase 项目规格。Free 计费类型会使用免费规格;付费类型规格需与控制台售卖规格一致。

2C4G

StorageSize

integer

否

存储空间大小,单位 GB。非 Free 计费类型不传时默认值为 1GB。

50

DiskPerformanceLevel

string

否

云盘性能等级。不传时默认值为 PL0。

可选值:

  • PL0

  • PL1

  • PL2

  • PL3

PL0

ClientToken

string

否

幂等 Token。用于保证重复请求不会重复执行同一操作。

123e4567-e89b-12d3-a456-426655440000

PayType

string

否

计费类型。不传时默认值为 Free。

可选值:

  • Free:免费类型。

  • Postpaid:按量付费。

  • Prepaid:包年包月。

Free

UsedTime

string

否

购买资源的时长。仅 PayType 为 PrePay 时生效;不传时默认值为 1。

1

Period

string

否

购买资源的时长单位。仅 PayType 为 PrePay 时生效;不传时默认值为 Month。

可选值:

  • Month:月。

  • Year:年。

Month

AutoScale

boolean

否

是否开启自动启停。不传时默认值为 false。

false

EngineVersion

string

否

引擎版本。不传时默认值为 PG15。PG17 及以上版本支持数据沙箱(分支)功能。

可选值:

  • PG15:PostgreSQL 15。

  • PG17:PostgreSQL 17,支持数据沙箱功能。

PG15

Tags

array<object>

否

标签列表。

object

否

标签列表中的元素。

Key

string

否

标签键。限制如下:

  • 不允许为空字符串。

  • 最多支持 128 个字符。

  • 不能以aliyun和acs:开头,不能包含http://或者https://。

test-key

Value

string

否

标签值。该值可以为空字符串。最多支持 128 个字符,不能包含http://或者https://。

test-value

Lightweight

boolean

否

是否是轻量版。

false

CreateOptions

string

否

创建可选参数。默认为空。

{}

BackupId

string

否

备份集 ID。

说明

您可以调用 ListSupabaseDataBackups 查看目标 Supabase 项目下所有备份集的备份集 ID。

2176307784

SrcProjectId

string

否

备份集所属的 Supabase 项目的 ID。

spb-xxxxxxxx

返回参数

名称

类型

描述

示例值

object

返回数据对象。

OrderId

string

关联订单 ID。

278880417310796

ProjectId

string

Supabase 实例 ID

spb-xxxx

RequestId

string

请求 ID

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B

示例

正常返回示例

JSON格式

{
  "OrderId": "278880417310796",
  "ProjectId": "spb-xxxx",
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。