CreateInstance - 创建实例--云搜索服务-火山引擎

文档中心

导航

CreateInstance - 创建实例

最近更新时间：2024.08.01 15:23:51首次发布时间：2023.11.30 14:19:27

调用 CreateInstance 接口，创建实例。

注意事项

通过调用 V2 版本的 CreateInstance 创建实例，将会返回火山订单 ID 和实例 ID 信息，此时实例处于待支付状态。您还需要额外在浏览器中确认火山订单信息，实例才会开始创建。
访问地址为：https://console.volcengine.com/finance/order/pay/?preOrderNumbers={OrderID}
请使用返回示例中的 OrderID 替换访问地址中的变量。
您可以选择调用CreateInstanceInOneStep接口，直接一步创建实例，更加方便。

请求说明

请求方式：POST
请求地址：/?Action=CreateInstance&Version=2023-01-01 HTTP/1.1

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateInstance`	接口名称。当前 API 的名称为 `CreateInstance`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
ClientToken	String	否	`123e4567-e89b-12d3-a456-426655440000`	幂等标识，用于在重试的场景下，避免重复操作。
InstanceConfiguration	Object of InstanceConfigurationAssign	是		实例配置详情。

InstanceConfigurationAssign

参数	类型	是否必选	示例值	描述
VPC	Object of VpcInfo	是		设置实例的私有网络 VPC 信息。
Period	Integer	否	`1`	包年包月实例的购买时长，单位：月。
Subnet	Object of SubnetInfo	是		设置实例的子网信息。说明设置的子网必须是主可用区中的子网。
ZoneId	String	是	`cn-beijing-a`	实例所在可用区。说明如果是多可用区部署，则填写多个 ZoneId，使用英文逗号分隔，如`cn-beijing-a,cn-beijing-c`。最左侧的 ZoneId 为主可用区，其余为备可用区。
Version	String	是	`V7_10`	实例版本。创建 ES 实例时，支持的版本包括V6_7和V7_10 创建 OpenSearch 实例时，支持的版本OPEN_SEARCH_2_9
RegionId	String	是	`cn-beijing`	实例所在区域。
AutoRenew	Boolean	否	`false`	包年包月实例是否配置自动续费。 true：自动续费，系统会在每次到期前自动为实例续费。 false：未开启自动续费，需要在实例到期前进行手动续费。如需了解更多，请参见实例续费。
ChargeType	String	是	`PostPaid`	实例计费类型。 PostPaid：按量计费。 PrePaid：包年包月。
EnableHttps	Boolean	是	`true`	是否启用 HTTPS 访问协议。 true：启用 HTTPS 访问。 false：不启用 HTTPS，使用 HTTP 访问。说明如果选择使用 HTTP 访问，将无需安全认证即可访问，并使用 HTTP 明文传输数据。您需要确保访问环境的安全性，且不要将访问接口暴露在公网环境上。实例创建完成后，支持根据业务需求修改传输协议。相关文档，请参见切换实例传输协议。
ProjectName	String	否	`default`	按需设置云搜索实例所属的项目，有利于云资源的分组管理。项目是火山引擎提供的一种资源管理方式，有利于维护资源独立、数据安全；同时可从项目维度查看资源消费账单，便于计算云资源使用成本。如需了解更多信息，请参见项目概述。
InstanceName	String	是	`doc-test`	自定义设置实例名称。只能包含中文、字母、数字、短横线（-）和下划线（_），开头和结尾不能是数字和短横线（-）。长度在 1～128 个字符内。
ResourceTags	Array of TagInfo	否		支持为实例添加标签，可以更方便的识别和管理实例。实例最多支持添加 20 个标签。标签为键值对样式，设置时注意以下事项：只支持大小写字母、数字、中文和特殊字符`.:/=+-_@`，键值大小写敏感。 Key 不允许以volc:、Volc:、vOlc:、volc:......（16 种组合）开头。 Key 长度为 1~128 字符；Value 长度为 0~256 字符。
AdminPassword	String	是	`Password**`	管理员密码。
EnableCerebro	Boolean	否	`true`	是否开启 cerebro。 true：开启 cerebro。 false：不开启 cerebro。
EnablePureMaster	Boolean	否	`true`	Master 节点是否独立。 true：Master 节点独立。 false：Master 节点与数据节点重合，即使用 Hot 声明。
NodeSpecsAssigns	Array of NodeSpecsAssign	是		实例中各种节点的数量和规格配置。
ConfigurationCode	String	否	`es.standard`	计费配置码，可以通过调用DescribeNodeAvailableSpecs接口获得。
DeletionProtection	Boolean	否	`true`	是否开启实例删除保护功能，取值说明如下： true：开启实例删除保护。 false：关闭实例删除保护。说明开启实例删除保护后，您将无法通过控制台或者 API 删除实例。

VpcInfo

参数	类型	是否必选	示例值	描述
VpcId	String	是	`vpc-274uhjap8u72****`	VPC ID。
VpcName	String	是	`vpc_nameA`	VPC 名称。

SubnetInfo

参数	类型	是否必选	示例值	描述
SubnetId	String	是	`subnet-1323sdda****`	Subnet ID。
SubnetName	String	是	`subnet_nameA`	Subnet 名称。

TagInfo

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Type	String	否	`CUSTOM`	节点标签的类型。 CUSTOM：自定义设置的标签。 SYSTEM：系统标签。
TagKvs	JSON Map	否	`user`	标签键。
TagKeys	Array of String	否	`tom`	标签值。

Type

String

否

CUSTOM

节点标签的类型。

CUSTOM：自定义设置的标签。
SYSTEM：系统标签。

TagKvs JSON Map 否 user 标签键。

TagKeys Array of String 否 tom 标签值。

NodeSpecsAssign

参数	类型	是否必选	示例值	描述
Type	String	否	`Hot`	节点类型。请先了解节点类型的作用，然后结合业务判断是否需要创建，详情请参见节点类型。 Master：Master 节点。 Hot：数据节点。 Cold：冷数据节点。 Warm：温数据节点。 Kibana：Kibana 节点。 Coordinator：协调节点。
Number	Integer	否	`2`	节点数量。配置数据节点数量时，在不同部署方式下，需要注意以下信息：单可用区部署：建议生产环境至少配置 3 个数据节点，配置 2 个节点时存在脑裂风险。如果启用专有主节点，2 个数据节点不会脑裂。双可用区部署，默认启用专有主节点：建议生产环境至少配置 4 个数据节点，即每个可用区两个数据节点。三可用区部署，默认启用专有主节点：建议生产环境至少配置 6 个数据节点，即每个可用区两个数据节点。数据节点数量可设范围为 1~100，如果有更多数据节点的需求，可申请开白提升配额到 200。配置 Master 节点：如果没有启用专有主节点，那么 Master 节点的配置和数据节点相同，否则 Master 配置是独立的。配置专有主节点，如需启用专有主节点，数量默认配置为 3。配置 Kibana 节点，数量固定为 1。配置协调节点，如需启用，生产环境建议至少 2 个协调节点，可配范围为 2~50。温数据节点：如需启用，生产环境建议至少 3 个温数据节点，最多可配置 100 个。
StorageSize	Integer	否	`100`	存储容量，单位为 GiB。默认值为 100GiB，调整步长为 10GiB。说明 Kibana 节点的 StorageSize 设置为0，即"StorageSize": 0。专有主节点和协调节点的 StorageSize 默认是 20。
StorageSpecName	String	否	`es.volume.essd.pl0`	存储规格名称，当前支持的规格如下： es.volume.essd.pl0：标准版-高性能云盘-pl0。 es.volume.essd.flexpl-standard：标准版-高性能云盘-flexpl。说明 Kibana 节点的 StorageSpecName 设置为空，即"StorageSpecName": ""。
ResourceSpecName	String	否	`es.x4.medium`	计算资源规格名称。您可以通过调用DescribeNodeAvailableSpecs接口获取可用的节点规格列表。如需了解规格详情，请参见V2 实例规格。

返回参数

参数	类型	示例值	描述
OrderID	String	`BO729***08233255`	订单 ID。
OrderNO	String	`BO729***08233255`	订单 ID。
InstanceId	String	`o-00***o718`	实例 ID。
TradeEnabled	Boolean	`true`	当前请求创建的实例是否接入计费。 true：已计费。 false：未计费。

请求示例

POST https://open.volcengineapi.com/?Action=CreateInstance&Version=2023-01-01
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256 
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
    "InstanceConfiguration": {
        "InstanceName": "doc-test-1",
        "ZoneNumber": 1,
        "RegionId": "cn-beijing",
        "ZoneId": "cn-beijing-a",
        "Version": "V7_10",
        "NodeSpecsAssigns": [
    {
      "Type": "Kibana",
      "Number": 1,
      "ResourceSpecName": "kibana.x2.small",
      "StorageSpecName": "",
      "StorageSize": 0
    },
    {
      "Type": "Master",
      "Number": 3,
      "ResourceSpecName": "es.x2.medium",
      "StorageSpecName": "es.volume.essd.pl0",
      "StorageSize": 20
    },
    {
      "Type": "Coordinator",
      "Number": 2,
      "ResourceSpecName": "es.x2.medium",
      "StorageSpecName": "es.volume.essd.pl0",
      "StorageSize": 20
    },
    {
      "Type": "Hot",
      "Number": 3,
      "ResourceSpecName": "es.x2.medium",
      "StorageSpecName": "es.volume.essd.pl0",
      "StorageSize": 20
    },
    {
      "Type": "Warm",
      "Number": 3,
      "ResourceSpecName": "es.x2.medium",
      "StorageSpecName": "es.volume.essd.pl0",
      "StorageSize": 100
    }
  ],
        "EnablePureMaster": true,
        "VPC": {
                "VpcId": "vpc-13fsc****3n6nu46g3mus",
                "VpcName": "wuch_vpc0110"
            },
        "Subnet": {
                "SubnetId": "subnet-rrzpa****7r53lac",
                "SubnetName": "wuch_A_sub"
            },
        "AdminUserName": "admin",
        "AdminPassword": "qaP****456",
        "EnableHttps": true,
        "DeletionProtection": true,
        "ConfigurationCode": "es.standard",
        "ChargeType": "PostPaid"
    }
}

返回示例

说明

{
    "ResponseMetadata": {
        "Action": "CreateInstance",
        "Region": "cn-beijing",
        "RequestId": "2023060411042001001002322***",
        "Service": "escloud",
        "Version": "2023-01-01"
    },
    "Result": {
        "OrderNO": "BO729***08233255",
        "OrderID": "BO729***08233255",
        "TradeEnabled": true,
        "InstanceId": "o-00***o718"
    }
}