最近更新时间:2024.04.09 15:04:00
首次发布时间:2023.11.30 14:19:27
调用 CreateInstanceInOneStep 接口,可以直接一步创建实例,支持创建 ES 实例和 OpenSearch 实例。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateInstanceInOneStep | 接口名称。当前 API 的名称为 CreateInstanceInOneStep 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-426655440000 | 幂等标识,用于在重试的场景下,避免重复操作。 |
InstanceConfiguration | Object of InstanceConfigurationAssign | 是 | 实例配置详情。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
VPC | Object of VpcInfo | 是 | 设置实例的私有网络 VPC 信息。 | |
Period | Integer | 否 | 1 | 包年包月实例的购买时长,单位:月。 |
Subnet | Object of SubnetInfo | 是 | 设置实例的子网信息。 | |
ZoneId | String | 是 | cn-beijing-a | 实例所在可用区。 |
Version | String | 是 | V7_10 | 实例版本。 |
RegionId | String | 是 | cn-beijing | 实例所在区域。 |
AutoRenew | Boolean | 否 |
| 包年包月实例是否配置自动续费。
|
ChargeType | String | 是 | PostPaid | 实例计费类型。 |
EnableHttps | Boolean | 是 |
| 是否启用 HTTPS 访问协议。 说明
|
ProjectName | String | 否 |
| 按需设置云搜索实例所属的项目,有利于云资源的分组管理。 |
InstanceName | String | 是 |
| 自定义设置实例名称。
|
ResourceTags | Array of TagInfo | 否 | 支持为实例添加标签,可以更方便的识别和管理实例。实例最多支持添加 20 个标签。
| |
AdminPassword | String | 是 |
| 管理员密码。取值规则如下:
|
EnableCerebro | Boolean | 否 |
| 是否开启 cerebro。
|
EnablePureMaster | Boolean | 否 | true | Master 节点是否独立。 |
NodeSpecsAssigns | Array of NodeSpecsAssign | 是 | 实例中各种节点的数量和规格配置。 | |
ConfigurationCode | String | 否 | es.standard | 计费配置码,可以通过调用DescribeNodeAvailableSpecs接口获得。 |
DeletionProtection | Boolean | 否 |
| 是否开启实例删除保护功能,取值说明如下:
说明 开启实例删除保护后,您将无法通过控制台或者 API 删除实例。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
VpcId | String | 是 | vpc-274uhjap8u72**** | VPC ID。 |
VpcName | String | 是 | vpc_nameA | VPC 名称。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
SubnetId | String | 是 | subnet-1323sdda**** | Subnet ID。 |
SubnetName | String | 是 | subnet_nameA | Subnet 名称。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Type | String | 否 |
| 节点标签的类型。
|
TagKvs | JSON Map | 否 | user | 标签键。 |
TagKeys | Array of String | 否 | tom | 标签值。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Type | String | 否 |
| 节点类型。请先了解节点类型的作用,然后结合业务判断是否需要创建,详情请参见节点类型。
|
Number | Integer | 否 |
| 节点数量。
|
StorageSize | Integer | 否 |
| 存储容量,单位为 GiB。 说明 Kibana 节点的 StorageSize 设置为0,即"StorageSize": 0。 |
StorageSpecName | String | 否 |
| 存储规格名称,当前支持的规格如下: 说明 Kibana 节点的 StorageSpecName 设置为空,即"StorageSpecName": ""。 |
ResourceSpecName | String | 否 |
| 计算资源规格名称。您可以通过调用DescribeNodeAvailableSpecs接口获取可用的节点规格列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String | o-008***iu98 | 创建的实例 ID。 |
InstanceId | String | doc-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***" } }