All Products
Search

This Product

    ApsaraDB RDS:CreateAppInstance

    Document Center

    ApsaraDB RDS:CreateAppInstance

    Last Updated:Mar 05, 2026

    Creates an RDS Supabase instance.

    Operation description

    Supported database engine

    RDS PostgreSQL

    References

    Note Fees of an instance are changed if the call is successful. Before you call this operation, carefully read the related topics.

    RDS Supabase

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rdsai:CreateAppInstancecreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The operation that you want to perform. Set the value to CreateAppInstance.

    		cn-beijing
    AppTypestringNo

    The region ID of the instance.

    		supabase
    VSwitchIdstringNo

    The application type. Only supabase is supported.

    		vsw-9dp2hkpm22gxscfgy****
    InstanceClassstringNo

    The vSwitch ID.

    		rdsai.supabase.basic
    DBInstanceNamestringNo

    The instance type. Only rdsai.supabase.basic is supported.

    		pgm-2ze49qv594vi****
    AppNamestringNo

    The ID of the RDS for PostgreSQL instance with which the RDS Supabase instances are associated.

    Note : Only newly purchased empty RDS for PostgreSQL instances are supported. The major engine version must be PostgreSQL 17 and the minor version must be 20250630 or later.
    		test-supabase
    ClientTokenstringNo

    The name of the new AI application.

    		ETnLKlblzczshOTUbOCz****
    DatabasePasswordstringNo

    The idempotency token. The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.

    		test_Password
    DashboardUsernamestringNo

    The password used to access the RDS database.

    The password must be 8 to 32 characters in length and must contain at least three of the following characters: uppercase letters, lowercase letters, digits, and underscores (_).

    		supabase
    DashboardPasswordstringNo

    The Supabase Dashboard user name.

    		test_Password
    PublicNetworkAccessEnabledbooleanNo

    The Supabase Dashboard password.

    The password must be 8 to 32 characters in length and must contain at least three of the following characters: uppercase letters, lowercase letters, digits, and underscores (_).

    		false
    RAGEnabledbooleanNo

    Specifies whether to enable the Internet NAT gateway. Valid values:

    • true: enable the Internet NAT gateway.
    • false (default): disable the Internet NAT gateway.
    Note If an Internet NAT gateway is enabled for the vSwitch that you specify for VSwitchId, select false for this parameter.
    		false
    DBInstanceConfigobjectNo

    A reserved parameter.

    PublicEndpointEnabledbooleanNo

    The billing method of the RDS for PostgreSQL instance.

    		true
    InitializeWithExistingDatabooleanNo

    Specifies whether to enable public endpoint.

    • true (default)
    • false
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		FE9C65D7-930F-57A5-A207-8C396329241C
    InstanceNamestring

    The ID of the RDS Supabase instance.

    		ra-supabase-8moov5lxba****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329241C",
  "InstanceName": "ra-supabase-8moov5lxba****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IncorrectInstanceStateCurrent instance status does not support this operation.The operation is not supported in the current instance state.
    400InvalidGroupNameSpecified group name is not valid.Invalid group name
    400InvalidParameterThe provided parameter is invalid.Invalid parameter.
    400MasterInstanceNotExistMaster instance does not exist.The primary instance does not exist.
    403InsufficientResourceCapacityThere is not enough host resource inventory.Insufficient resources

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2025-12-19The Error code has changed. The request parameters of the API has changedView Change Details
    2025-11-25The Error code has changed. The request parameters of the API has changedView Change Details