调用createInstance,创建Elasticsearch实例。

在调用接口前,请注意:

  • 请确保在使用该接口前,已充分了解Elasticsearch产品的收费方式和价格。
  • 创建实例需要通过实名认证,详情请参见实名认证相关文档。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /openapi/instances HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
clientToken String 5A2CFF0E-5718-45B5-9D4D-70B3FF****

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

Body请求参数

参数

类型

是否必选

示例值

描述

paymentType

String

postpaid

付费类型,支持postpaid(按量计费)和prepaid(包年包月)。

period

int

1

如果paymentType为prepaid(包年包月),则需要指定预付费的周期,支持的值包括:1,2,3,4,5,6,7,8,9,12,24,36,单位:月。

nodeAmount

int

3

数据节点个数,如果有购买冷数据节点,则此参数表示热数据节点个数。

instanceCategory

String

advanced

版本类型。支持advanced(增强版)、x-pack(商业版)。设置为advanced时,必须购买Master节点和CPFS共享存储。

esAdminPassword

String

es_password

ES实例的访问密码。

nodeSpec

Map

数据节点配置。

└spec

String

elasticsearch.sn2ne.xlarge

规格名称。

└disk

String

20

单数据节点硬盘大小,单位:GB。

└diskType

String

cloud_ssd

硬盘类型,支持cloud_ssd(SSD云盘)和cloud_efficiency(高效云盘)。

esVersion

String

5.5.3_with_X-Pack

ES实例版本,支持5.5.3_with_X-Pack、6.3_with_X-Pack、6.7_with_X-Pack。

advancedDedicateMaster

boolean

false

是否创建专有主节点,如果是多可用区部署则必选。

masterConfiguration

Map

专有主节点配置。advancedDedicateMaster为true时必填。

└spec

String

elasticsearch.sn2ne.xlarge

规格名称。

└amount

int

3

数量,目前固定为3。

└disk

int

20

专有主节点的硬盘大小。单位:GB。当前只支持20GB。

└diskType

string

cloud_ssd

专有主节点的硬盘类型,当前只支持cloud_ssd(SSD云盘)。

warmNode

boolean

false

是否购买冷数据节点。

warmNodeConfiguration

Map

冷数据节点配置。warmNode为true时必填。

└spec

string

elasticsearch.ic5.large

规格名称。

└amount

Integer

2

数量。

└diskType

string

cloud_efficiency

磁盘类型。

└disk

Integer

500G

磁盘大小。

└diskEncryption

boolean

true

磁盘是否加密。

haveClientNode

boolean

false

是否购买协调节点。

clientNodeConfiguration

Map

协调节点配置。haveClientNode为true时必填。

└spec

string

elasticsearch.ic5.large

规格名称。

└amount

Integer

2

数量。

└diskType

string

cloud_efficiency

磁盘类型。

└disk

Integer

20G

磁盘大小。

haveKibana

boolean

true

是否购买kibana节点。

kibanaConfiguration

Map

kibana节点配置。haveKibana为true时必填。

└spec

String

elasticsearch.n4.small

规格名称。

└amount

Integer

1

数量,目前固定为1。

└disk

Integer

0

存储大小,目前固定为0。

说明 └表示子参数。

返回数据

名称 类型 示例值 描述
RequestId String E9A685FC-8344-4765-A5A5-7B67CDD6BE2F

请求ID。

Result Struct

返回结果。

instanceId String es-cn-l99z2h20y9346****

实例ID。

示例

请求示例

POST /openapi/instances HTTP/1.1
公共请求头

正常返回示例

XML 格式

<description>es_java_sdk_cretest</description>
<esAdminPassword>&lt;your_password&gt;</esAdminPassword>
<esVersion>5.5.3_with_X-Pack</esVersion>
<networkConfig>
    <type>vpc</type>
    <vpcId>vpc-bp16k1dvzxtmagcva****</vpcId>
    <vsArea>cn-hangzhou-i</vsArea>
    <vswitchId>vsw-bp1k4ec6s7sjdbudw****</vswitchId>
</networkConfig>
<nodeAmount>2</nodeAmount>
<nodeSpec>
    <disk>20</disk>
    <spec>elasticsearch.n4.small</spec>
</nodeSpec>
<haveKibana>true</haveKibana>
<kibanaConfiguration>
    <spec>elasticsearch.n4.small</spec>
    <amount>1</amount>
    <disk>0</disk>
</kibanaConfiguration>
<paymentType>postpaid</paymentType>

JSON 格式

{
  "description": "es_java_sdk_cretest",
  "esAdminPassword": "<your_password>",
  "esVersion": "5.5.3_with_X-Pack",
  "networkConfig": {
    "type": "vpc",
    "vpcId": "vpc-bp16k1dvzxtmagcva****",
    "vsArea": "cn-hangzhou-i",
    "vswitchId": "vsw-bp1k4ec6s7sjdbudw****"
  },
  "nodeAmount": 2,
  "nodeSpec": {
    "disk": 20,
    "spec": "elasticsearch.n4.small"
  },
  "haveKibana":true,
  "kibanaConfiguration":{
     "spec": "elasticsearch.n4.small",
      "amount": 1,
      "disk": 0
     },
  "paymentType": "postpaid"
}

错误码

HttpCode 错误码 错误信息 描述
401 UserNotOpen Aliyun account is not open elasticsearch 用户未开通,请先开通服务
401 StsRoleAccountNoPermission Role account has no permission or expired 角色无权限或者权限到期,请先授予角色相应权限并确保在权限到期前完成操作
401 SubAccountNoPermission Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM 子账户无权限,请核对子账号权限
401 UserUnauthorized Authentication required 用户验证失败,请先登录并核对是否有权限

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