CreateApplication - PolarDB - Alibaba Cloud Documentation Center

Creates an application for 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: Pass this value to create a managed Supabase application. raycluster: Pass this value to create a managed Ray Cluster application.	supabase
DBClusterId	string	No	The ID of the PolarDB instance on which the application depends.	pc-**************
RegionId	string	No	The region. The default is the region of the instance.	cn-beijing
ZoneId	string	No	The zone. The default is the primary zone of the instance.	cn-beijing-k
VSwitchId	string	No	The vSwitch. The default is the current vSwitch in the primary zone of the instance.	vsw-*********************
Architecture	string	Yes	The CPU architecture. Valid value: x86	x86
Endpoints	array<object>	No	A list of custom service Endpoints. By default, a VPC Endpoint is created.
	object	No	The service Endpoint.
Description	string	No	The description of the service Endpoint.	my_endpoint
EndpointType	string	No	The type of the service Endpoint. This is fixed to Primary.	Primary
Components	array<object>	No	A list of custom subcomponents for the application.
	object	No	The application subcomponent.
ComponentType	string	No	The type of the application subcomponent. For supabase, valid values are: gateway backend For raycluster, 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 whitelist for the application subcomponent. Separate multiple IP addresses with commas.	127.0.0.1
SecurityIPType	string	No	The type of IP addresses in the whitelist for the application subcomponent. The default is ipv4.	ipv4
SecurityIPArrayName	string	No	The name of the IP address whitelist group for the application subcomponent. The default is default.	default
SecurityGroups	string	No	A list of security groups for the application subcomponent. Separate multiple security group IDs with commas.	sg-********************
ComponentMaxReplica	integer	No	The maximum number of subcomponents for the application that have the same specifications. The default is the value of ComponentReplica. This parameter is supported only for raycluster.	1
ScaleMin	string	No
ScaleMax	string	No
PayType	string	No	The billing method.	Postpaid
AutoRenew	boolean	No	Specifies whether to enable auto-renewal.	true
Period	string	No	The subscription type. Valid values are annual and monthly.	Year
UsedTime	string	No	The subscription duration.	1
ResourceGroupId	string	No	The resource group ID.	rg-********************
DryRun	boolean	No	The default is `false`. Set this to `true` to check only the parameters and resources without creating the resources.	false
PolarFSInstanceId	string	No	The ID of the PolarFileSystem (PolarFS) Cold Storage or High-Performance instance. The default is empty. If you specify this parameter, the corresponding storage is mounted to the application. This parameter is supported only for the following applications: supabase raycluster	pcs-********************
VpcId	string	No
AutoCreatePolarFs	boolean	No	Specifies whether to automatically create a PolarFileSystem (PolarFS) Cold Storage 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 a coupon. false: Do not use a coupon.	true
PromotionCode	string	No	The coupon code. If you do not specify this parameter, the default coupon is used.	727xxxxxx934
SecurityGroupId	string	No
MemApplicationSpec	object	No
LlmModel	string	No
EmbedderModel	string	No
RerankerModel	string	No
ProjectName	string	No
DbName	string	No
DbUser	string	No
DbPassword	string	No
GraphLlmModel	string	No
EmbedderModelDimension	integer	No
Shard	integer	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
ResourceAvailable	boolean	Indicates whether the resources are sufficient. This is returned only when `DryRun` is set to `true`.	true
ApplicationId	string	The application ID.	pa-********************
Description	string	The description of the application.	myapp
Components	array<object>	The list of subcomponents.
	object	The subcomponent.
ComponentId	string	The subcomponent ID.	pac-********************
OrderId	string	The ID of the order.	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.