调用createInstance,创建Elasticsearch实例。

在调用接口前,请注意:

  • 请确保在使用该接口前,已充分了解Elasticsearch产品的收费方式和价格。

    详情请参见阿里云Elasticsearch定价

  • 创建实例需要通过实名认证。

    详情请参见实名认证

调试

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

请求头

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

请求语法

POST /openapi/instances HTTP/1.1

请求参数

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

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

String Body { "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" } }

请求体参数。

RequestBody

RequestBody中还需要填入以下参数,用来指定待创建的实例信息。

参数

类型

是否必选

示例值

描述

zoneCount

String

2

指定实例的可用区数量。可选值:1、2、3,默认值:1。

paymentType

String

postpaid

付费类型。可选值:postpaid(按量计费)、prepaid(包年包月)。

paymentInfo

Map

postpaid

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

└duration

Integer

1

购买时间,支持按月和按年购买。创建包年包月实例时,必填。

└pricingCycle

String

Month

包年包月单位,支持:Year(年)、Month(月)。创建包年包月实例时,必填。

└isAutoRenew

Boolean

true

是否开启自动续费设置。可选值:true(开启)、false(不开启)。默认为false,不开启。

└autoRenewDuration

Integer

3

自动续费周期,单位:月。isAutoRenewtrue时必填,参数值可选范围与售卖页一致。

nodeAmount

int

3

数据节点个数。

instanceCategory

String

advanced

版本类型。可选值:IS(Indexing Service系列实例)、x-pack(商业版)。创建增强版开启OpenStore的实例需要同时开启Indexing Service。

esAdminPassword

String

es_password

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

esVersion

String

5.5.3_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。

nodeSpec

Map

数据节点配置。

└spec

String

elasticsearch.sn2ne.xlarge

节点规格,规格信息可通过产品规格查看。

└disk

String

20

单节点存储空间,单位:GB。

└diskType

String

cloud_ssd

存储类型。可选值:cloud_ssd(SSD云盘)、cloud_essd(ESSD云盘)、cloud_efficiency(高效云盘)。

└performanceLevel

String

PL1

ESSD云盘的性能级别。当存储类型为cloud_essd时,该参数必选,支持PL1、PL2、PL3。

└diskEncryption

Boolean

true

是否开启云盘加密,可选值:true(开启)、false(不开启)。

masterConfiguration

Map

专有主节点配置。

└spec

String

elasticsearch.sn2ne.xlarge

节点规格,规格信息可通过产品规格查看。

└amount

int

3

节点数量,目前固定为3。

└disk

int

20

单节点存储空间大小。当前只支持20GB。

└diskType

string

cloud_ssd

节点存储类型。可选值:cloud_ssd(SSD云盘)、cloud_essd(ESSD云盘)。

warmNodeConfiguration

Map

冷数据节点配置。

└spec

string

elasticsearch.ic5.large

节点规格,规格信息可通过产品规格查看。openstore.i2g.4xlarge规格表示开启OpenStore存储。

└amount

Integer

2

节点数量。

└diskType

string

cloud_efficiency

节点存储类型。可选值:cloud_efficiency(高效云盘)。普通商业版支持选择冷数据节点的磁盘类型,日志增强版不需要设置此值。

└disk

Integer

500

单节点存储空间。

clientNodeConfiguration

Map

协调节点配置。

└spec

string

elasticsearch.ic5.large

节点规格,规格信息可通过产品规格查看。

└amount

Integer

2

节点数量。

└diskType

string

cloud_efficiency

节点存储类型。可选值:cloud_efficiency(高效云盘)。

└disk

Integer

20

单节点存储空间大小。

elasticDataNodeConfiguration

Map

弹性节点配置。

└spec

string

elasticsearch.ic5.large

节点规格,规格信息可通过产品规格查看。

└amount

Integer

2

数量。

└diskType

string

cloud_efficiency

节点存储类型。可选值:cloud_ssd(SSD云盘)、cloud_essd(ESSD云盘)、cloud_efficiency(高效云盘)。

└disk

Integer

20

单节点存储空间大小。

└performanceLevel

String

PL1

ESSD云盘的性能级别。当存储类型为cloud_essd时,该参数必选,支持PL1、PL2、PL3。

└diskEncryption

Boolean

true

是否开启云盘加密,可选值:true(开启)、false(不开启)。

kibanaConfiguration

Map

kibana节点配置。

└spec

String

elasticsearch.n4.small

节点规格,规格信息可通过产品规格查看。

networkConfig

Map

网络配置。

└type

string

VPC

网络类型。目前仅支持专有网络。

└vpcId

string

vpc-bp16k1dvzxtmagcva****

专有网络ID。

└vsArea

string

cn-hangzhou-i

交换机所在的可用区。

└vswitchId

string

vsw-bp1k4ec6s7sjdbudw****

交换机ID。

dryRun

boolean

true

创建实例时是否校验配置,可选值:true(只校验,不创建)、false(校验并创建)。

说明

示例如下。

  • 创建通用商业版实例,同时包含冷、热节点。
    
    {
      "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"
      }
    }
    

返回数据

名称 类型 示例值 描述
RequestId String 838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3

请求ID。

Result Object

返回结果。

instanceId String es-is-0u2ecp69tt****

实例ID。

示例

请求示例

POST /openapi/instances?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "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"
  }
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<createInstanceResponse>
    <RequestId>838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3</RequestId>
    <Result>
        <instanceId>es-is-0u2ecp69tt****</instanceId>
    </Result>
</createInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3",
  "Result" : {
    "instanceId" : "es-is-0u2ecp69tt****"
  }
}

错误码

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