All Products
Search
Document Center

PolarDB:CreatePolardbxSupabaseInstance

Last Updated:Sep 10, 2026

Creates a Supabase instance.

Operation description


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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID.

cn-hangzhou

ZoneId

string

Yes

The zone ID.

cn-beijing-h

VpcId

string

Yes

VPC ID

vpc-bp1ndoug37dtwoedlmru0

VSwitchId

string

Yes

The vSwitch ID.

vsw-*********

PayType

string

Yes

The billing type. Valid values:

  • PREPAY: subscription.

  • POSTPAY: pay-as-you-go.

PREPAY

DbPassword

string

Yes

The database password.

dTyMQem0o3HOAFh!

DashboardPassword

string

Yes

The dashboard password.

dTyMQem0o3HOAFh!

TenantMode

boolean

No

Specifies whether to enable multi-tenant mode.

false

NodeSpec

string

No

The node specifications.

polarx.supabase.x2.small

UsedTime

integer

No

The subscription duration.

1

Period

string

No

The billing cycle. Valid values:

  • Year

  • Month

  • Hour

Month

AutoRenew

boolean

No

Specifies whether to enable auto-renewal.

true

DbInstanceDescription

string

No

The instance description.

Supabase实例

ResourceGroupId

string

No

The resource group ID.

null

ClientToken

string

No

The idempotency token.

FEA5DC20-6D8A-5979-97AA-FC57546ADC20

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

C457B28E-9CAB-4B77-B5C6-5D71B7870B6E

Data

object

The creation result.

DBInstanceId

string

The instance ID.

pxsp-xxxxxxxxxx

OrderId

integer

The order ID.

265325896860727

ConnectionString

string

The endpoint.

test2.polarx.huhehaote.rds.aliyuncs.com

Port

integer

The port.

3300

AccessDeniedDetail

object

The details of the access denial.

AuthAction

string

The authentication action.

xxx

AuthPrincipalType

string

The authentication principal type.

222

NoPermissionType

string

The type of the permission denial.

ImplicitDeny

PolicyType

string

The policy type.

PRIORITY

EncodedDiagnosticMessage

string

The encoded diagnostic message.

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

AuthPrincipalOwnerId

string

The owner ID of the authentication principal.

111

AuthPrincipalDisplayName

string

The display name of the authentication principal.

xxx

Examples

Success response

JSON format

{
  "RequestId": "C457B28E-9CAB-4B77-B5C6-5D71B7870B6E",
  "Data": {
    "DBInstanceId": "pxsp-xxxxxxxxxx",
    "OrderId": 265325896860727,
    "ConnectionString": "test2.polarx.huhehaote.rds.aliyuncs.com",
    "Port": 3300
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "PRIORITY",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.