CreateApplication-阿里云帮助中心

Creates an application attached to 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 or remark of the application.	myapp
Parameters	array<object>	No	The list of parameters.
	object	No	The list of parameters.
ParameterName	string	No	The name of the parameter.	secret.gateway.auth.token
ParameterValue	string	No	The value of the parameter.	TK***
AgenticDBBranchSpec	object	No	The AgenticDB branch specifications.	{"DBClusterId":"pagc-2zea920mcvd5o87","TenantId":"t-cfc2d7df0e59439681f0087f51","ProjectId":"proj-d7849d0050664c758af795d468","BranchId":"br-9054b3b7649e4c0d977bd0df37","ForkFromBranch":true,"ForkFromApplicationId":"pa-source"}
BranchId	string	No	The ID of the AgenticDB branch.	br-9054b3b7649e4c0d977bd0df37
DBClusterId	string	No	The ID of the AgenticDB cluster.	pagc-2zea920mcvd5o87
ForkFromApplicationId	string	No	The ID of the source application.	pa-source
ForkFromBranch	boolean	No	Specifies whether to create the application based on a specified AgenticDB branch.	true
ProjectId	string	No	The ID of the AgenticDB project.	proj-d7849d0050664c758af795d468
TenantId	string	No	The ID of the AgenticDB tenant.	t-cfc2d7df0e59439681f0087f51
Storages	array<object>	No	The list of application storages.	[{"StorageType":"oss","StorageInstanceId":"pfs-xxxx","EndpointId":"pe-xxxx"}]
	object	No
ContainerMountPath	string	No	The mount path in the container.	/data/container
EndpointId	string	No	The ID of the storage endpoint.	pe-xxxx
MountPath	string	No	The mount path of the storage.	/data/source
StorageCapacity	string	No	The storage capacity.	100
StorageEndpoint	string	No	The access endpoint of the storage.	polarfs.example.com
StorageInstanceId	string	No	The ID of the storage instance.	pfs-xxxx
StoragePerformanceLevel	string	No	The storage performance level.	PL1
StorageType	string	No	The type of the storage.	oss
ApplicationType	string	Yes	The application type. Valid values: supabase: Specify this value to create a managed Supabase application. raycluster: Specify this value to create a managed Ray Cluster application. polarclaw: Specify this value to create a managed PolarClaw application.	supabase
DBClusterId	string	No	The ID of the PolarDB instance on which the application depends.	pc-**************
RegionId	string	No	The region ID. Default value: the region of the instance.	cn-beijing
ZoneId	string	No	The zone ID. Default value: the primary zone of the instance.	cn-beijing-k
VSwitchId	string	No	The vSwitch ID. Default value: the current vSwitch in the primary zone of the instance.	vsw-*********************
Architecture	string	Yes	The CPU architecture. Valid values: x86	x86
SecurityIPList	string	No	The IP address whitelist. If you do not specify this parameter, the default value 127.0.0.1 is used.	127.0.0.1,172.17.0.0/24
SecurityIPType	string	No	The type of the IP address.	ipv4
SecurityIPArrayName	string	No	The name of the IP address whitelist group. Default value: default.	default
Endpoints	array<object>	No	The list of custom service endpoints. By default, a VPC endpoint is created.
	object	No	The service endpoint.
Description	string	No	The remark of the service endpoint.	my_endpoint
EndpointType	string	No	The type of the service endpoint. Set the value to Primary.	Primary
Components	array<object>	No	The list of custom application subcomponents.
	object	No	The application subcomponent.
ComponentClass	string	No	The specifications of the application subcomponent.	polar.app.g2.medium
ComponentMaxReplica	integer	No	The maximum number of application subcomponents of the same specifications. Default value: the value of ComponentReplica. This parameter is supported only by raycluster.	1
ComponentReplica	integer	No	The number of replicas for the application subcomponent. Default value: 1.	1
ComponentType	string	No	The type of the application subcomponent. For supabase, valid values: gateway backend For raycluster, valid values: head worker gpuworker	gateway
ScaleMax	string	No	The upper limit for component scaling.	16
ScaleMin	string	No	The lower limit for component scaling.	1
SecurityGroups	string	No	The list of security groups for the application subcomponent. Separate multiple security group IDs with commas (,).	sg-********************
SecurityIPArrayName	string	No	The name of the IP address whitelist group for the application subcomponent. Default value: default.	default
SecurityIPList	string	No	The IP addresses in the whitelist for the application subcomponent. Separate multiple IP addresses with commas (,).	127.0.0.1
SecurityIPType	string	No	The type of the IP addresses in the whitelist for the application subcomponent. Default value: ipv4.	ipv4
PayType	string	No	The billing method.	Postpaid
AutoRenew	boolean	No	Specifies whether to enable auto-renewal.	true
Period	string	No	The subscription period unit.	Year
UsedTime	string	No	The subscription duration.	1
ResourceGroupId	string	No	The ID of the resource group.	rg-********************
DryRun	boolean	No	Specifies whether to perform a dry run. Default value: false. If you set this parameter to true, only parameter and resource validation is performed, and no resources are actually created.	false
PolarFSInstanceId	string	No	The ID of the Polarlakebase Cold Storage Edition or High-performance Edition instance. Default value: empty. If you specify this parameter, the corresponding storage is mounted to the application. Currently, only the following applications support this parameter: supabase raycluster	pcs-********************
VpcId	string	No	The ID of the virtual private cloud (VPC).	vpc-********************
AutoCreatePolarFs	boolean	No	Specifies whether to automatically create a Polarlakebase Cold Storage Edition instance. Valid values: false (default): Do not automatically create the instance. true: Automatically create the instance.	false
AutoUseCoupon	boolean	No	Specifies whether to automatically use a coupon. Valid values: true (default): Use the coupon. false: Do not use the coupon.	true
PromotionCode	string	No	The coupon code. If you do not specify this parameter, the default coupon is used.	727xxxxxx934
SecurityGroupId	string	No	The ID of the security group.	sg-********************
MemApplicationSpec	object	No	The required parameters for mem0 applications.
DbName	string	No	The database name.	test-database-name
DbPassword	string	No	The password.	test-user-password
DbUser	string	No	The username.	test-user
EmbedderModel	string	No	Required for mem0 applications. The name of the embedder model, such as text-embedding-v4.	text-embedding-v4
EmbedderModelDimension	integer	No	The vector dimensions.	1024
GraphLlmModel	string	No	The graph LLM model.	qwen-plus
LlmModel	string	No	Required for mem0 applications. The name of the LLM model, such as qwen3-max.	qwen3-max
MemoryType	string	No	The memory type, such as multimodal.	MULTIMODAL_TEXT
PolarAIEmbedderInstanceId	string	No	The instance ID of the PolarAI embedding model.	pm-xxx
PolarAIGraphLlmInstanceId	string	No	The instance ID of the PolarAI graph LLM model.	pm-xxx
PolarAILlmInstanceId	string	No	The instance ID of the PolarAI LLM model.	pm-xxx
PolarAIRerankerInstanceId	string	No	The instance ID of the PolarAI reranker model.	pm-xxx
ProjectName	string	No	The project name, which corresponds to the schema in the database where project data is stored.	test-project-name
RerankerModel	string	No	Required for mem0 applications. The name of the reranker model, such as qwen3-rerank.	qwen3-rerank
Shard	integer	No	The number of shards.	1
VisualEmbedderModel	string	No	The name of the visual embedder model.	qwen3.7-text-embedding
VisualEmbedderModelDimension	integer	No	The vector dimensions of the visual embedder.	2560
VisualLlmModalities	array	No	The list of modalities for the visual LLM, such as image.
	string	No	The modality supported by the visual LLM.	image
VisualLlmModel	string	No	The name of the visual LLM model.	qwen3.6-flash
KnowledgeApplicationSpec	object	No	The required parameters for knowledge applications.
DashboardPassword	string	No	The dashboard password.	test-dashboard-password
DbPassword	string	No	The password.	test-user-password
LlmModel	string	No	Required for knowledge applications. The name of the LLM model, such as qwen3-max.	qwen3-max
ModelFrom	string	No	The model source. Valid values: bailian: Model Studio model. custom: Custom model. maas: PolarDB model operator.	bailian
AIDBClusterId	string	No	The ID of the associated existing model operator instance. This parameter takes effect only when ApplicationType is set to polarclaw.	pm-xxxxxx
ModelApiKey	string	No	The model API key. This parameter takes effect only when ApplicationType is set to polarclaw.	sk-xxxxxx
ModelBaseUrl	string	No	The model endpoint. This parameter takes effect only when ApplicationType is set to polarclaw.	https://dashscope.aliyuncs.com/compatible-mode/v1
ModelApi	string	No	The model API. This parameter takes effect only when ApplicationType is set to polarclaw.	openai-completions
ModelName	string	No	The model name. This parameter takes effect only when ApplicationType is set to polarclaw.	qwen3-max
AutoAllocatePublicEip	boolean	No	Specifies whether to automatically create and attach an EIP.
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key.	testKey
Value	string	No	The tag value.	testValue
TargetVersion	string	No	The target version.	latest
AuthProvider	string	No	The authentication service provider.	feishu
AuthProviderConfig	string	No	The authentication provider configuration.	xxx
SkillTemplateId	string	No	The skill template ID.	xxx
VpcNatGatewayId	string	No	The NAT gateway ID of the self-managed VPC NAT gateway for NAT mapping. If you specify this parameter, NAT mapping is enabled when the instance is created. The NAT gateway must be in the same VPC as the application, use the private network (intranet) type, and be active.	ngw-xxx
DnatIpAddress	string	No	The DNAT-specific NAT IP address allocated for NAT mapping, which is separate from the SNAT IP address. The IP address must belong to the NAT gateway, be in the available state, and the vSwitch where the gateway resides must belong to a primary CIDR block reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: An SNAT entry is associated with the vSwitch where the application resides.	10.64.0.10
DnatEntries	array<object>	No	The list of expected DNAT entries for NAT mapping. Specify this parameter together with VpcNatGatewayId. If this parameter is left empty, no DNAT entries are created.
	object	No	The DNAT entry.
FrontPort	integer	No	The frontend port. This parameter is optional. By default, the system automatically assigns a port that is not occupied by the gateway. You can call the DescribeApplicationAttribute operation to query the assigned port.	10001
PortName	string	No	The name of the port. Valid values: webui, hermesagent, dashboard, and ssh.	webui
AgenticDBClusterId	string	No	The ID of the AgenticDB cluster.	pagc-xxx

Response elements

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.