云搜索服务
云搜索服务
文档指南
请输入
- 文档首页
云搜索服务API 参考实例管理CreateInstance - 创建实例
复制全文
下载 pdfCreateInstance - 创建实例
文档反馈
问问助手调用 CreateInstance 接口，创建实例。
注意事项
通过调用 CreateInstance 创建实例，将会返回火山订单 ID 和实例 ID 信息，此时实例处于待支付状态。您还需要额外在浏览器中确认火山订单信息，实例才会开始创建。访问地址为：https://console.volcengine.com/finance/order/pay/?preOrderNumbers={OrderID}。请使用返回示例中的 OrderID 替换访问地址中的变量。您可以选择调用 CreateInstanceInOneStep 接口，直接一步创建实例，更加方便。
请求说明
- 请求方式：POST
- 请求地址：/?Action=CreateInstance&Version=2023-01-01 HTTP/1.1
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：CreateInstance
要执行的操作，取值：CreateInstance。
Version string 必选 示例值：2023-01-01
API的版本，取值：2023-01-01。
Tags object[] 可选 示例值：[{"Key": "key1", "Value": "value1"}]
绑定的标签列表。
Key string 必选 示例值：test-tag
标签键。
Value string 必选 示例值：test-value
标签值。
ClientToken string 可选 示例值：123e4567-e89b-12d3-a456-426655440000
幂等标识，用于在重试的场景下，避免重复操作。
InstanceConfiguration object 必选 示例值：--
实例配置详情。
VPC object 必选
设置实例的私有网络 VPC 信息。
VpcId string 必选 示例值：vpc-274uhjap8u72****
VPC ID。
VpcName string 必选 示例值：vpc_nameA
VPC 名称。
Period integer 可选 示例值：1
包年包月实例的购买时长，单位：月。
Subnet object 必选
设置实例的子网信息。
说明
设置的子网必须是主可用区中的子网。
SubnetId string 必选 示例值：subnet-1323sdda****
Subnet ID。
SubnetName string 必选 示例值：subnet_nameA
Subnet 名称。
ZoneId string 必选 示例值：cn-beijing-a
实例所在可用区。
说明
如果是多可用区部署，则填写多个 ZoneId，使用英文逗号分隔，如cn-beijing-a,cn-beijing-c。最左侧的 ZoneId 为主可用区，其余为备可用区。
Version string 必选 示例值：V7_10
实例版本。
- 创建 Elasticsearch 实例时，支持的版本包括 V6_7、V6_8 和 V7_10。
- 创建 OpenSearch 实例时，支持的版本 OPEN_SEARCH_2_9。
注意
RegionId string 必选 示例值：cn-beijing
实例所在区域。
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 个字符内。
EnablePureMaster boolean 可选 示例值：true
Master 节点是否独立。
- true：Master 节点独立。
- false：Master 节点与数据节点重合，即使用 Hot 声明。
NodeSpecsAssigns object[] 必选
实例中各种节点的数量和规格配置。
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 个。
- 冷数据节点：如需启用，生产环境建议至少 2 个温数据节点，最多可配置 100 个。
StorageSize integer 可选 示例值：100
存储容量，单位为 GiB。
默认值为 100 GiB，调整步长为 10 GiB。
说明
- 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
ExtraPerformance object 可选
磁盘额外性能包相关配置。
Throughput integer 必选 示例值：100
当您的数据节点选择使用 FlexPL 存储类型，且存储规格配置为 500 GiB 及以上时，支持购买带宽包增加磁盘带宽。
单位为 MiB，调整步长为 10 MiB。
当前支持的存储规格及对应额外性能包吞吐量上限如下：
- es.volume.essd.flexpl-standard：650
ConfigurationCode string 可选 示例值：es.standard
DeletionProtection boolean 可选 示例值：true
是否开启实例删除保护功能，取值说明如下：
- true：开启实例删除保护。
- false：关闭实例删除保护。
说明
开启实例删除保护后，您将无法通过控制台或者 API 删除实例。
NetworkSpecs object[] 可选
实例公网规格配置。
Type string 必选 示例值：Elasticsearch
公网应用类型。
- Elasticsearch：Elasticsearch 实例使用。
- Kibana：Dashboard 使用。
Bandwidth integer 必选 示例值：1
公网 IP 的带宽上限，默认为 1，单位：Mbps。
IsOpen boolean 必选 示例值：true
开启/关闭。
SpecName string 必选 示例值：es.eip.bgp_fixed_bandwidth
AdminPassword string 必选 示例值：Password**
管理员密码。
AutoRenew boolean 可选 示例值：true
包年包月实例是否配置自动续费，默认true。
- true：自动续费，系统会在每次到期前自动为实例续费。
- false：未开启自动续费，需要在实例到期前进行手动续费。
- 如需了解更多，请参见实例续费。
返回参数
OrderID string 示例值：BO729***08233255
订单 ID。
OrderNO string 示例值：BO729***08233255
订单编号。
InstanceId string 示例值：o-00***o718
实例 ID。
TradeEnabled boolean 示例值：true
当前请求创建的实例是否接入计费。
- true：已计费。
- false：未计费。
请求示例
POST /?Action=CreateInstance&Version=2023-01-01
Host: escloud.cn-beijing.volcengineapi.com
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",
"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"
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
200 | IllegalParameter | illegal parameter | 参数非法。原因可能是参数缺失或不符合接口要求。 |
200 | InternalServerError | 服务器内部异常 | 服务由于异常退出，无法完成接口请求操作。 |
200 | Unauthorized | unauthorized error | 用户无权限调用接口。 |
最近更新时间：2026.05.09 10:44:27
这个页面对您有帮助吗？
有用
有用
无用
无用