Deploy PolarDB Apps Automatically via CreateApplication API - PolarDB - Alibaba Cloud - PolarDB

Creates an application associated with a PolarDB 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

polardb:CreateApplication

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Description	string	No	The description of the application.	myapp
ApplicationType	string	Yes	The application type. Valid values: `supabase`: Creates a managed Supabase application. `raycluster`: Creates a managed Ray Cluster application. `polarclaw`: Creates a managed PolarClaw application.	supabase
DBClusterId	string	No	The ID of the PolarDB instance that the application requires.	pc-**************
RegionId	string	No	The region ID. By default, this is the region of the specified PolarDB instance.	cn-beijing
ZoneId	string	No	The zone ID. By default, this is the primary zone of the specified PolarDB instance.	cn-beijing-k
VSwitchId	string	No	The ID of the vSwitch. By default, this is the vSwitch in the primary zone of the specified PolarDB instance.	vsw-*********************
Architecture	string	Yes	The CPU architecture. Valid value: `x86`	x86
SecurityIPList	string	No
SecurityIPType	string	No
SecurityIPArrayName	string	No
Endpoints	array<object>	No	A list of custom service endpoints. By default, a VPC endpoint is created.
	object	No	A service endpoint.
Description	string	No	The description of the service endpoint.	my_endpoint
EndpointType	string	No	The type of the service endpoint. This value must be `Primary`.	Primary
Components	array<object>	No	A list of custom application subcomponents.
	object	No	An application subcomponent.
ComponentType	string	No	The type of the application subcomponent. For `supabase` applications, valid values are: `gateway` `backend` For `raycluster` applications, valid values are: `head` `worker` `gpuworker`	gateway
ComponentClass	string	No	The specifications of the application subcomponent.	polar.app.g2.medium
ComponentReplica	integer	No	The number of replicas for the application subcomponent. The default is 1.	1
SecurityIPList	string	No	The IP address allowlist for the application subcomponent. Separate multiple IP addresses with a comma.	127.0.0.1
SecurityIPType	string	No	The type of the IP addresses in the application subcomponent's allowlist. Default value: `ipv4`.	ipv4
SecurityIPArrayName	string	No	The name of the IP address allowlist group for the application subcomponent. Default value: `default`.	default
SecurityGroups	string	No	The IDs of the security groups for the application subcomponent. Separate multiple IDs with a comma.	sg-********************
ComponentMaxReplica	integer	No	The maximum number of replicas for an application subcomponent with the same specifications. Defaults to the value of `ComponentReplica`. This parameter is supported only for `raycluster` applications.	1
ScaleMin	string	No
ScaleMax	string	No
PayType	string	No	The billing method.	Postpaid
AutoRenew	boolean	No	Specifies whether to enable auto-renewal for the application.	true
Period	string	No	The unit of the subscription duration.	Year
UsedTime	string	No	The subscription duration.	1
ResourceGroupId	string	No	The ID of the resource group.	rg-********************
DryRun	boolean	No	If set to `true`, this performs a dry run to check for request validity and resource availability without creating the application. Default: `false`.	false
PolarFSInstanceId	string	No	The ID of the Polarlakebase Cold Storage or High-Performance instance. This parameter is empty by default. If you provide an ID, the corresponding storage is mounted to the application. This parameter is supported only by the following applications: `supabase` `raycluster`	pcs-********************
VpcId	string	No	The ID of the Virtual Private Cloud (VPC).
AutoCreatePolarFs	boolean	No	Specifies whether to automatically create a Polarlakebase Cold Storage instance. Valid values: `false` (default): Does not automatically create an instance. `true`: Automatically creates an instance.	false
AutoUseCoupon	boolean	No	Specifies whether to automatically apply a coupon. Valid values: `true` (default): A coupon is automatically applied. `false`: A coupon is not applied.	true
PromotionCode	string	No	The code for a specific coupon. If you use this parameter, set `AutoUseCoupon` to `false`.	727xxxxxx934
SecurityGroupId	string	No	The ID of the security group.
MemApplicationSpec	object	No	This parameter is required for `mem0` applications.
LlmModel	string	No	The name of the large language model (LLM). This parameter is required for `mem0` applications. Example: `qwen3-max`.
EmbedderModel	string	No	The name of the embedder model. This parameter is required for `mem0` applications. Example: `text-embedding-v4`.
RerankerModel	string	No	The name of the reranker model. This parameter is required for `mem0` applications. Example: `qwen3-rerank`.
ProjectName	string	No	The project name. This name specifies the database schema for storing project data.
DbName	string	No	The database name.
DbUser	string	No	The username.
DbPassword	string	No	The password.
GraphLlmModel	string	No	The name of the graph LLM.
EmbedderModelDimension	integer	No	The vector dimension.
Shard	integer	No	The number of shards.
ModelFrom	string	No	The source of the model. Valid values: `bailian`: A Model Studio model. `custom`: A custom model. `maas`: A PolarDB model operator.	bailian
AIDBClusterId	string	No	The ID of an existing model operator instance. This parameter applies only when `ApplicationType` is set to `polarclaw`.	pm-xxxxxx
ModelApiKey	string	No	The API key for the model. This parameter applies only when `ApplicationType` is set to `polarclaw`.	sk-xxxxxx
ModelBaseUrl	string	No	The base URL of the model. This parameter applies only when `ApplicationType` is set to `polarclaw`.	https://dashscope.aliyuncs.com/compatible-mode/v1
ModelApi	string	No	The model API. This parameter applies only when `ApplicationType` is set to `polarclaw`.	openai-completions
ModelName	string	No	The model name. This parameter applies only when `ApplicationType` is set to `polarclaw`.	qwen3-max
AutoAllocatePublicEip	boolean	No	Specifies whether to automatically allocate a public elastic IP address (EIP).
Tag	array<object>	No	A list of tags to add to the application.
	object	No	A tag.
Key	string	No	The key of the tag.	testKey
Value	string	No	The value of the tag.	testValue
TargetVersion	string	No	The version of the application to deploy.	latest

Response elements

Element	Type	Description	Example
	object	The response parameters.
ResourceAvailable	boolean	Specifies whether sufficient resources are available. This parameter is returned only when `DryRun` is set to `true`.	true
ApplicationId	string	The application ID.	pa-********************
Description	string	The application description.	myapp
Components	array<object>	A list of subcomponents.
	object	A subcomponent.
ComponentId	string	The subcomponent ID.	pac-********************
OrderId	string	The or****ID.	2148126708*****
RequestId	string	The request ID.	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
ResourceGroupId	string	The resource group ID.	rg-********************

Examples

Success response

JSON format

{
  "ResourceAvailable": true,
  "ApplicationId": "pa-********************",
  "Description": "myapp",
  "Components": [
    {
      "ComponentId": "pac-********************"
    }
  ],
  "OrderId": "2148126708*****",
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "ResourceGroupId": "rg-********************"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.