All Products
Search

This Product

    AnalyticDB:CreateSupabaseProject

    Document Center

    AnalyticDB:CreateSupabaseProject

    Last Updated:Mar 31, 2026

    Creates a Supabase instance.

    Operation description

    • This API is used to create 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 available regions.

    cn-hangzhou
    ProjectName

    string

    Yes

    The project name. Naming rules:

    • The name must be 1 to 128 characters long.

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

    • The name 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 available availability zones.

    cn-hangzhou-h
    AccountPassword

    string

    Yes

    The password for the initial account.

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

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

    • The password must be 8 to 32 characters long.

    Pw123456
    SecurityIPList

    string

    Yes

    The IP allowlist for the instance.

    A value of 127.0.0.1 blocks all external access. You can call the ModifySecurityIps operation to modify the IP allowlist after the instance is created.

    127.0.0.1
    VpcId

    string

    Yes

    The VPC ID. This parameter is required.

    Note

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

    string

    Yes

    The vSwitch ID. This parameter is required.

    Note

    • The vSwitch must be in the availability zone specified by ZoneId.

    vsw-bp1cpq8mr64paltkb****
    ProjectSpec

    string

    Yes

    The specifications of the Supabase instance. The default specification for the free tier is 1C1G. For paid tiers, see the console for available specifications.

    1C1G
    StorageSize

    integer

    No

    The storage size, in GB. Default value: 1.

    2
    DiskPerformanceLevel

    string

    No

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

    • PL0

    • PL1

    PL0
    ClientToken

    string

    No

    A client token 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 this parameter is not specified, a free-tier instance is created by default.

    • Discounts are available for annual or longer subscriptions.

    Postpaid
    UsedTime

    string

    No

    The subscription duration. This parameter is required for subscription instances. Valid values:

    • If Period is set to Month, the value can be an integer from 1 to 11.

    • If Period is set to Year, the value can be an integer from 1 to 3.

    Note

    This parameter is required when you create an instance that uses the subscription billing method.

    1
    Period

    string

    No

    The unit of the subscription duration. This parameter is required for subscription instances. Valid values:

    • Month

    • Year

    Note

    This parameter is required when you create an instance that uses the subscription billing method.

    Month

    Response elements

    Element

    Type

    Description

    Example

    object

    The response object.

    ProjectId

    string

    The Supabase instance ID.

    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.