AI 助理
文档备案控制台
官方文档
首页 检索分析服务 Elasticsearch版 开发参考 API参考（Elasticsearch） API目录 实例 createInstance - 创建ES实例

createInstance - 创建ES实例

更新时间：
复制 MD 格式
产品详情
我的收藏

创建Elasticsearch实例。

接口说明

注意事项

  • 请确保在使用该接口前，已充分了解 Elasticsearch 产品的收费方式和价格。详情请参见阿里云 Elasticsearch 计费规则。

  • 创建实例需要通过实名认证。详情请参见实名认证。

  • 创建实例时不需要指定可用区，实例默认与所选 VPC 在同一可用区中。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:CreateInstance

create

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/*
  • elasticsearch:DataNodeDiskEncryption
  • elasticsearch:WarmNodeDiskEncryption
 无

请求语法

POST /openapi/instances HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
clientToken

string

否

用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。

5A2CFF0E-5718-45B5-9D4D-70B3FF****
body

object

否

请求体参数。

{ "description": "xpack-hot-cold", "nodeAmount": 2, "esVersion": "7.10_with_X-Pack", "instanceCategory": "x-pack", "nodeSpec": { "spec": "elasticsearch.sn2ne.xlarge", "disk": 20, "diskType": "cloud_ssd" }, "warmNodeConfiguration": { "spec": "elasticsearch.sn1ne.xlarge", "amount": 3, "diskType": "cloud_efficiency", "disk": 500 }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "postpaid", "esAdminPassword": "yourPassword", "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" } }
clientNodeConfiguration ClientNodeConfiguration

否

协调节点配置。

description

string

否

实例名称。

es
elasticDataNodeConfiguration ElasticDataNodeConfiguration

否

弹性节点配置。

esAdminPassword

string

是

实例的访问密码。要求包含以下字符中的三种：大写字母、小写字母、数字、特殊字符：!@#$%^&*()_+-=，长度为 8~32 位。

Es_password
esVersion

string

是

实例版本。可选值：

  • 8.5.1_with_X-Pack

  • 7.10_with_X-Pack

  • 6.7_with_X-Pack

  • 7.7_with_X-Pack

  • 6.8_with_X-Pack

  • 6.3_with_X-Pack

  • 5.6_with_X-Pack

  • 5.5.3_with_X-Pack

说明

以上所列版本不一定包含 Elasticsearch 实例支持的所有版本，实际支持的版本可调用 GetRegionConfiguration 接口查看。

5.5.3_with_X-Pack
indexNodeConfiguration IndexNodeConfiguration

否

仅 AI 引擎类型实例支持设置索引节点

instanceCategory

string

否

版本类型：

  • x-pack：创建商业版实例，或不开启 Indexing Service 和 OpenStore 的内核增强版实例。

  • IS：创建开启 Indexing Service 或 OpenStore 的内核增强版实例。

advanced
kibanaConfiguration KibanaNodeConfiguration

否

Kibana 节点配置。

说明

强烈建议开启 Kibana 节点。

masterConfiguration MasterNodeConfiguration

否

专有主节点配置。

说明

在北京、上海、杭州和深圳地域，通过 createInstance 创建新一代云盘型专有主节点的实例时，需指定规格族+后缀.new，例如， elasticsearch.sn1ne.large.new。

networkConfig NetworkConfig

是

网络配置。

说明

创建实例时不支持指定 IP 白名单。

nodeAmount

integer

是

数据节点个数，取值范围为 2~50。

3
nodeSpec NodeSpec

否

数据节点配置。

说明

在北京、上海、杭州和深圳地域，通过 createInstance 创建新一代云盘型数据节点的实例时，需指定规格族+后缀.new，例如， elasticsearch.sn1ne.large.new。

paymentInfo PaymentInfo

否

包年包月实例的付费详情。创建包年包月实例时必填。

paymentType

string

否

付费类型。可选值：

  • postpaid：按量计费

  • prepaid：包年包月

postpaid
resourceGroupId

string

否

实例所属的资源组 ID。

rg-aekzu7tsu4n****
searchNodeConfiguration SearchNodeConfiguration

否

仅 AI 引擎实例支持设置查询节点

tags

array<object>

否

实例标签组。

object

否

实例标签。

tagKey

string

否

实例的标签键。

KeyTest
tagValue

string

否

实例的标签值。

KeyValue
warmNodeConfiguration WarmNodeConfiguration

否

冷数据节点配置。

zoneCount

integer

否

实例的可用区数量。可选值：1、2、3，默认值：1。

2
说明

  • diskType 参数是节点的存储类型，普通云盘型规格该参数必填，本地盘规格该参数非必填。

请求体参数示例如下：

  • 创建通用商业版实例，同时包含冷、热节点。

{
  "description": "xpack-hot-cold",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "x-pack",
  "nodeSpec": {
    "spec": "elasticsearch.sn2ne.xlarge",
    "disk": 20,
    "diskType": "cloud_ssd"
  },
  "warmNodeConfiguration": {
    "spec": "elasticsearch.sn1ne.xlarge",
    "amount": 3,
    "diskType": "cloud_efficiency",
    "disk": 500
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

  • 创建 Indexing Service 系列实例，只包含热节点。

{
  "description": "is-hot",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "nodeSpec": {
    "spec": "elasticsearch.sn1ne.xlarge",
    "disk": 20,
    "diskType": "cloud_ssd"
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

  • 创建 Indexing Service 系列实例，只包含冷节点。

{
  "description": "is-cold",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "warmNodeConfiguration": {
    "spec": "group.c6.large.500",
    "amount": 3,
    "disk": 300
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

  • 创建 Indexing Service 系列实例，同时包含冷、热节点。

{
  "description": "is-hot-cold",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "nodeSpec": {
    "spec": "elasticsearch.sn2ne.xlarge",
    "disk": 50,
    "diskType": "cloud_ssd"
  },
  "warmNodeConfiguration": {
    "spec": "group.c6.large.500",
    "amount": 3,
    "disk": 300
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

  • 创建 Indexing Service 系列实例，开启 OpenStore 存储，同时包含冷、热节点。

{
  "description": "os-1",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "nodeSpec": {
    "spec": "elasticsearch.sn2ne.xlarge",
    "disk": 50,
    "diskType": "cloud_ssd"
  },
  "warmNodeConfiguration": {
    "spec": "openstore.i2g.4xlarge",
    "amount": 3
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

  • 创建 Indexing Service 系列实例，开启 OpenStore 存储，包含冷热共享型节点。

{
  "description": "os-2",
  "nodeAmount": 2,
  "esVersion": "7.10_with_X-Pack",
  "instanceCategory": "IS",
  "nodeSpec": {
    "spec": "openstore.i2g.4xlarge",
    "disk": 50,
    "diskType": "cloud_ssd"
  },
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-8vbfu74bmw4m7m84a****",
    "vswitchId": "vsw-8vbnk6cmurbpump2f****",
    "vsArea": "cn-zhangjiakou-c"
  },
  "paymentType": "postpaid",
  "esAdminPassword": "yourPassword",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn1ne.large"
  }
}

  • 创建通用商业版 7.10 版本实例，并开启自动续费。

说明

paymentType 设置为 prepaid，表示实例为预付费模式。自动续费在 paymentInfo 参数中设置。

{
 "description": "自动续费",
 "nodeAmount": 3,
 "instanceCategory": "x-pack",
 "esVersion": "7.10_with_X-Pack",
 "nodeSpec": {
 "spec": "elasticsearch.sn2ne.xlarge",
 "disk": 50,
 "diskType": "cloud_ssd"
 },
 "kibanaConfiguration": {
 "spec": "elasticsearch.sn1ne.large"
 },
 "networkConfig": {
 "type": "vpc",
 "vpcId": "vpc-8vbfu74bmw4m7m84a****",
 "vswitchId": "vsw-8vbnk6cmurbpump2f****",
 "vsArea": "cn-zhangjiakou-c"
 },
 "paymentType": "prepaid",
 "paymentInfo": {
 "duration": 1,
 "pricingCycle": "Month",
 "isAutoRenew": true,
 "autoRenewDuration": 1
 },
 "esAdminPassword": "yourPassword"
}

  • 创建 9.X(Agent 引擎版实例)

说明

注意 es 版本为 9.99, Agent 引擎版 支持查询节点、索引节点、kibana 节点、master 节点；不支持数据节点、冷节点、协调节点

{
  "esAdminPassword": "******",
  "esVersion": "9.99",
  "indexNodeConfiguration": {
    "amount": 2,
    "disk": 200,
    "diskType": "cloud_essd",
    "performanceLevel": "PL0",
    "spec": "elasticsearch.turbo2.cae.large"
  },
  "instanceCategory": "x-pack",
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-****",
    "vsArea": "cn-hangzhou-k",
    "vswitchId": "vsw-***"
  },
  "nodeAmount": 0,
  "searchNodeConfiguration": {
    "amount": 2,
    "disk": 200,
    "diskType": "cloud_essd",
    "performanceLevel": "PL0",
    "spec": "elasticsearch.turbo2.cae.large"
  },
  "zoneCount": 1,
  "paymentType": "postpaid",
  "kibanaConfiguration": {
    "spec": "elasticsearch.sn2ne.large"
  }
}

返回参数

名称

类型

描述

示例值

当前API暂无返回参数

返回参数

名称类型示例值描述
RequestIdString838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3请求 ID。
Resultobject返回结果。
└instanceIdstringes-is-0u2ecp69tt****实例 ID。

示例

正常返回示例

JSON格式

{}

错误码

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

变更历史

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

上一篇：ListInstanceIndices - ListInstanceIndices下一篇：EstimatedRestartTime - 实例重启预估时间