You need to enable JavaScript to run this app.
导航
云搜索服务
  • 文档首页
    • /
  • 云搜索服务

CreateInstanceInOneStep - 单步新建实例

最近更新时间：2024.04.09 15:04:00

首次发布时间：2023.11.30 14:19:27

我的收藏

调用 CreateInstanceInOneStep 接口，可以直接一步创建实例，支持创建 ES 实例和 OpenSearch 实例。

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionString是CreateInstanceInOneStep接口名称。当前 API 的名称为 CreateInstanceInOneStep。
VersionString是2023-01-01接口版本。当前 API 的版本为 2023-01-01。

Body

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

InstanceConfigurationAssign

参数类型是否必选示例值描述
VPCObject of VpcInfo是设置实例的私有网络 VPC 信息。
PeriodInteger否1包年包月实例的购买时长，单位：月。
SubnetObject of SubnetInfo是设置实例的子网信息。
ZoneIdString是cn-beijing-a实例所在可用区。
VersionString是V7_10实例版本。
  • 创建 ES 实例时，支持的版本包括V6_7和V7_10
  • 创建 OpenSearch 实例时，支持的版本OPEN_SEARCH_2_9
    • RegionIdString是cn-beijing实例所在区域。

    AutoRenew

    Boolean

    否

    false

    包年包月实例是否配置自动续费。

    • true：自动续费，系统会在每次到期前自动为实例续费。
    • false：未开启自动续费，需要在实例到期前进行手动续费。
      如需了解更多，请参见实例续费。
    ChargeTypeString是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**

    管理员密码。取值规则如下：

    • 密码至少包含大写字母、小写字母、数字和特殊字符中的三种，长度为 8～32 个字符。
    • 支持_#!@$%^&*()+=-特殊字符，不可以包含空格和中文。

    EnableCerebro

    Boolean

    否

    false

    是否开启 cerebro。

    • true：开启 cerebro。
    • false：不开启 cerebro。
    EnablePureMasterBoolean否trueMaster 节点是否独立。
  • true：Master 节点独立。
  • false：Master 节点与数据节点重合，即使用 Hot 声明。
    • NodeSpecsAssignsArray of NodeSpecsAssign是实例中各种节点的数量和规格配置。
    ConfigurationCodeString否es.standard计费配置码，可以通过调用DescribeNodeAvailableSpecs接口获得。

    DeletionProtection

    Boolean

    否

    true

    是否开启实例删除保护功能，取值说明如下：

    • true：开启实例删除保护。
    • false：关闭实例删除保护。

    说明

    开启实例删除保护后，您将无法通过控制台或者 API 删除实例。

    VpcInfo

    参数类型是否必选示例值描述
    VpcIdString是vpc-274uhjap8u72****VPC ID。
    VpcNameString是vpc_nameAVPC 名称。

    SubnetInfo

    参数类型是否必选示例值描述
    SubnetIdString是subnet-1323sdda****Subnet ID。
    SubnetNameString是subnet_nameASubnet 名称。

    TagInfo

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

    Type

    String

    否

    CUSTOM

    节点标签的类型。

    • CUSTOM：自定义设置的标签。
    • SYSTEM：系统标签。
    TagKvsJSON Map否user标签键。
    TagKeysArray of String否tom标签值。

    NodeSpecsAssign

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

    Type

    String

    否

    Hot

    节点类型。请先了解节点类型的作用，然后结合业务判断是否需要创建，详情请参见节点类型。

    • Master：Master 节点。
    • Hot：数据节点。
    • Cold：冷数据节点。
    • Warm：温数据节点。
    • Kibana：Kibana 节点。
    • Coordinator：协调节点。

    Number

    Integer

    否

    2

    节点数量。

    1. 配置数据节点数量时，在不同部署方式下，需要注意以下信息：
      • 单可用区部署：建议生产环境至少配置 3 个数据节点，配置 2 个节点时存在脑裂风险。
      • 双可用区部署，默认启用专有主节点：建议生产环境至少配置 4 个数据节点，即每个可用区两个数据节点。
      • 三可用区部署，默认启用专有主节点：建议生产环境至少配置 6 个数据节点，即每个可用区两个数据节点。
      • 数据节点数量可设范围为 1~100，如果有更多数据节点的需求，可申请开白提升配额到 200。
    2. 配置 Master 节点，与数据节点配置相同。
    3. 配置专有主节点，如需启用专有主节点，数量默认配置为 3。
    4. 配置 Kibana 节点，数量固定为 1。
    5. 配置协调节点，如需启用，生产环境建议至少 2 个协调节点，可配范围为 2~50。
    6. 温数据节点：如需启用，生产环境建议至少 3 个温数据节点，最多可配置 100 个。

    StorageSize

    Integer

    否

    100

    存储容量，单位为 GiB。
    默认值为 100GiB，调整步长为 10GiB。

    说明

    Kibana 节点的 StorageSize 设置为0，即"StorageSize": 0。

    StorageSpecName

    String

    否

    es.volume.essd.pl0

    存储规格名称，当前支持的规格如下：
    es.volume.essd.pl0：标准版-高性能云盘-pl0。

    说明

    Kibana 节点的 StorageSpecName 设置为空，即"StorageSpecName": ""。

    ResourceSpecName

    String

    否

    es.x4.medium

    计算资源规格名称。您可以通过调用DescribeNodeAvailableSpecs接口获取可用的节点规格列表。
    如需了解规格详情，请参见V2 实例规格。

    返回参数

    参数类型示例值描述
    NameStringo-008***iu98创建的实例 ID。
    InstanceIdStringdoc-test实例名称。

    请求示例

    POST https://open.volcengineapi.com/?Action=CreateInstanceInOneStep&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": {
                "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": "Hot",
                        "Number": 3,
                        "ResourceSpecName": "es.x2.medium",
                        "StorageSpecName": "es.volume.essd.pl0",
                        "StorageSize": 30
                }, {
                        "Type": "Warm",
                        "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
                }],
                "InstanceName": "doc-test",
                "Version": "V7_10",
                "RegionId": "cn-beijing",
                "ZoneId": "cn-beijing-b",
                "ZoneNumber": 1,
                "EnableHttps": true,
                "AdminUserName": "admin",
                "AdminPassword": "qaPwd*****",
                "EnablePureMaster": true,
                "ChargeType": "PostPaid",
                "ConfigurationCode": "es.standard",
                "ProjectName": "default",
                "DeletionProtection": false,
                "VPC": {
                        "VpcId": "vpc-13fs**6g3mus",
                        "VpcName": "wu**_vpc0110"
                },
                "Subnet": {
                        "SubnetId": "subnet-13f****pfdmug",
                        "SubnetName": "wu***_B_sub"
                } 
        }
}

    返回示例

    {
    "ResponseMetadata": {
        "RequestId": "20240402143235C6321AF36AE68***",
        "Action": "CreateInstanceInOneStep",
        "Version": "2023-01-01",
        "Service": "escloud",
        "Region": "cn-beijing"
    },
    "Result": {
        "Name": "doc-test-2",
        "InstanceId": "o-0080w3***"
    }
}