CreateApp - 创建应用_检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

调用CreateApp接口，创建Elasticsearch Serverless应用。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
es-serverless:CreateApp		全部资源 *	无	无

请求语法

POST /openapi/es-serverless/instances

请求参数

名称	类型	必填	描述	示例值
body	object	否	Body 参数。
appName	string	是	应用名称。	test
description	string	否	应用备注。	test
network	array<object>	否	公网信息。
	object	否	公网信息具体结构。
type	string	否	IP 白名单的类型： PUBLIC_ES：Elasticsearch 公网访问白名单 PUBLIC_KIBANA：Kibana 公网访问白名单	PUBLIC_ES
enabled	boolean	否	是否开启公网访问。	true
domain	string	否	域名信息。	test-123.serverless.cn-hangzhou.elasticsearch.aliyuncs.com
port	integer	否	端口号。	9200
whiteIpGroup	array<object>	否	白名单列表。
	object	否	白名单具体结构。
groupName	string	否	白名单组的组名。如果选填了 whiteIpGroup 参数，则该参数必填。	default
ips	array	否	白名单组中的 IP 地址列表。
	string	否	具体 IP 或 IP 段。	127.0.0.1
authentication	object	是	认证信息。
basicAuth	array<object>	否	基础信息。
	object	否	基础信息。
username	string	否	用户名。	test-123
password	string	否	密码。	******
regionId	string	否	应用所在的地域。	cn-hangzhou
version	string	否	应用版本，默认 7.10 版本。	7.10
chargeType	string	是	付费类型。当前仅支持按量付费：POSTPAY。	POSTPAY
quotaInfo	object	否	配额信息。
cu	integer	否	单个应用的弹性计算资源上限。单位：CU。	6
storage	integer	否	单个应用的索引最大存储量。单位：GB。	24
appType	string	否	应用类型： STANDARD：企业版， TRIAL：入门版	STANDARD
privateNetwork	array<object>	否	私网信息。
	object	否	私网信息具体结构。
type	string	否	IP 白名单的类型： PRIVATE_KIBANA：Kibana 私网访问白名单 PRIVATE_ES：Elasticsearch 私网访问白名单	PRIVATE_ES
enabled	boolean	否	是否开启私网访问。	true
whiteIpGroup	array<object>	否	白名单列表。
	object	否	白名单具体结构。
groupName	string	否	白名单组的组名。如果选填了 whiteIpGroup 参数，则该参数必填。	default
ips	array	否	白名单组中的 IP 地址列表。
	string	否	具体 IP 或 IP 段。	127.0.0.1
vpcId	string	否	终端节点所在 VPC 的 ID。	vpc-bp1jy348ibzulk6hn****
pvlEndpointId	string	否	终端节点 ID。	ep-bp1id41dd116e52e****
scenario	string	否	应用使用场景： SEARCH：检索场景 LOG：时序日志场景	SEARCH
dryRun	boolean	否	是否校验入参数据合法性并创建应用，默认 false。 true：只校验参数合法性。 false：校验参数合法性，并创建应用。	false

返回参数

名称	类型	描述	示例值
	object	响应体结构。
requestId	string	请求 ID。	2C5DAA30-****-5181-9B87-9D6181016197
result	object	返回结果。
instaneId	string	应用对应的实例 id。	es-serverless-cn-xxx

示例

正常返回示例

JSON格式

{
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197",
  "result": {
    "instaneId": "es-serverless-cn-xxx"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-04-24	OpenAPI 入参发生变更	查看变更详情
2024-01-24	API 内部配置变更，不影响调用	查看变更详情
2023-10-19	OpenAPI 入参发生变更	查看变更详情