You need to enable JavaScript to run this app.
导航
CreateInstance - 创建实例
最近更新时间:2024.10.21 17:17:53首次发布时间: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

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

CreateInstance

要执行的操作,取值:CreateInstance。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

Tags
Array of Object

[{"Key": "key1", "Value": "value1"}]

绑定的标签列表

ClientToken
String

123e4567-e89b-12d3-a456-426655440000

幂等标识,用于在重试的场景下,避免重复操作。

InstanceConfiguration
Object

--

实例配置详情。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
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"
        }
    }
    

    错误码

    下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

    状态码
    错误码
    错误信息
    说明
    200
    IllegalParameter
    illegal parameter

    非法参数。可能是参数缺失,也可能是参数不符合接口要求

    200
    InternalServerError
    服务器内部异常

    服务由于异常退出,无法完成接口请求操作

    200
    Unauthorized
    unauthorized error

    用户无权限调用接口