调用CreateApplicationAPI创建PolarDB应用-云原生数据库 PolarDB-阿里云

用于创建一个附属于PolarDB实例的应用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:CreateApplication

get

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Description	string	否	应用描述/备注	myapp
ApplicationType	string	是	应用类型，取值范围为 supabase: 若创建托管 Supabase 应用，请传入此值 raycluster: 若创建托管 Ray Cluster 应用，请传入此值	supabase
DBClusterId	string	否	应用依赖的 PolarDB 实例 ID	pc-**************
RegionId	string	否	地域，默认为实例地域	cn-beijing
ZoneId	string	否	可用区，默认为实例主可用区	cn-beijing-k
VSwitchId	string	否	交换机，默认为实例主可用区当前的交换机	vsw-*********************
Architecture	string	是	CPU 架构，取值范围 x86	x86
Endpoints	array<object>	否	用户自定义的服务端点列表，默认创建一个 VPC Endpoint
	object	否	服务端点
Description	string	否	服务端点备注	my_endpoint
EndpointType	string	否	服务端点类型，固定为 Primary	Primary
Components	array<object>	否	用户自定义的应用子组件列表
	object	否	应用子组件
ComponentType	string	否	应用子组件的类型对于 supabase，取值范围为 gateway backed 对于 raycluster，取值范围为 head worker gpuworker	gateway
ComponentClass	string	否	应用子组件的规格	polar.app.g2.medium
ComponentReplica	integer	否	应用子组件的副本数量，默认为 1	1
SecurityIPList	string	否	应用子组件的白名单 IP 地址，英文逗号分隔	127.0.0.1
SecurityIPType	string	否	应用子组件的白名单 IP 的类型，默认为 ipv4	ipv4
SecurityIPArrayName	string	否	应用子组件白名单 IP 地址组的名称，默认为 default	default
SecurityGroups	string	否	应用子组件的安全组列表，使用英文逗号分隔	sg-********************
ComponentMaxReplica	integer	否	同一规格应用子组件的最大数量，默认等于 ComponentReplica 仅 raycluster 支持该参数	1
ScaleMin	string	否
ScaleMax	string	否
PayType	string	否	付费类型	Postpaid
AutoRenew	boolean	否	自动续费	true
Period	string	否	包年或包月类型	Year
UsedTime	string	否	期限	1
ResourceGroupId	string	否	资源组 ID	rg-********************
DryRun	boolean	否	默认为`false`，设置为`true`后将只进行参数和资源校验，不实际创建资源。	false
PolarFSInstanceId	string	否	PolarFS 冷存版/高性能版实例 ID，默认为空，若传入则将相应存储挂载到应用中目前仅如下应用支持 supabase raycluster	pcs-********************
VpcId	string	否

返回参数

名称	类型	描述	示例值
	object	Schema of Response
ResourceAvailable	boolean	资源是否满足，仅`DryRun`为`true`时返回	true
ApplicationId	string	应用 ID	pa-********************
Description	string	应用备注	myapp
Components	array<object>	子组件列表
	object	子组件
ComponentId	string	子组件 ID	pac-********************
OrderId	string	生成的订单 ID	2148126708*****
RequestId	string	请求 ID	3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF
ResourceGroupId	string	资源组 ID	rg-********************

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。