CreatePolardbxSupabaseInstance - PolarDB - Alibaba Cloud Documentation Center

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

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

polardbx:CreatePolardbxSupabaseInstance

create

*All Resource

*

None

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 method. Valid values: PREPAY and POSTPAY.	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, and Hour.	Month
AutoRenew	boolean	No	Specifies whether to enable auto-renewal.	true
DbInstanceDescription	string	No	The description of the instance.	Supabase instance
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 access denied details.
AuthAction	string	The authentication action.	xxx
AuthPrincipalType	string	The type of the authentication principal.	222
NoPermissionType	string	The no permission type.	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.