调用 CreateInstanceInOneStep 接口,可以直接一步创建实例,支持创建 ES 实例和 OpenSearch 实例。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateInstanceInOneStep | 要执行的操作,取值:CreateInstanceInOneStep。 |
Version | String | 是 | 2023-01-01 | API的版本,取值:2023-01-01。 |
ClientToken | String | 否 |
| 幂等标识,用于在重试的场景下,避免重复操作。 |
InstanceConfiguration | Object | 是 | -- | 实例配置详情。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String |
| 创建的实例 ID。 |
InstanceId | String |
| 实例名称。 |
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***" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
200 | Unauthorized | 用户无权限调用接口 |
200 | IllegalParameter | 非法参数。可能是参数缺失,也可能是参数不符合接口要求 |
200 | InternalServerError | 服务由于异常退出,无法完成接口请求操作 |