RunCluster - 新建集群--ByteHouse 企业版-火山引擎

文档中心

ByteHouse 企业版

集群管理

RunCluster - 新建集群

新建一个包年包月的ByteHouse企业版集群

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	RunCluster	要执行的操作，取值：RunCluster。
Version	String	是	2025-05-31	API的版本，取值：2025-05-31。
NewClusterName	String	是	bytehouse_cluster	集群名称
CPU	Integer	是	4	每个节点的CPU核心数
Memory	Integer	是	16	每个节点的内存大小(GB)
Replicas	Integer	是	2	副本数量
NodeCount	Integer	是	2	节点总数
StorageGBPerNode	Integer	是	100	每个节点的存储容量(GB)
RegionId	String	是	cn-shanghai	区域ID
ZoneId	String	是	cn-shanghai-a	可用区ID
VpcId	String	是	vpc-xxx	VPC ID
SecurityGroupIds	Array of String	是	["sg-xxx"]	安全组ID列表
SubnetId	String	是	subnet-xxx	子网ID
Description	String	否	description	集群描述
Months	Integer	否	1	购买时长(月)
AutoRenew	Double	否	1	是否自动续费

返回参数

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

参数	类型	示例值	描述
Message	String	""	返回消息
Data	Object	{ "InstanceId": "Bytehouse_enterprisexxxxxxx" }	新建集群返回

请求示例

POST /?Action=RunCluster&Version=2024-08-31 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250804T074754Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/bytehouse_ce_rc/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "NewClusterName": "bytehouse_cluster",
  "CPU": 4,
  "Memory": 16,
  "Replicas": 2,
  "NodeCount": 2,
  "StorageGBPerNode": 100,
  "RegionId": "cn-shanghai",
  "ZoneId": "cn-shanghai-a",
  "VpcId": "vpc-id",
  "SecurityGroupIds": [
    "sg-id"
  ],
  "SubnetId": "subnet-id"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250804154832131115116236B43A58",
    "Action": "RunCluster",
    "Version": "2024-08-31",
    "Service": "bytehouse_ce_rc",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": {
      "InstanceId": "Bytehouse_enterprisexxxxxxx"
    }
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	Bad Request	api service received invalid request format	参数错误
500	InternalError	The request has failed due to an unknown error.

最近更新时间：2026.04.08 22:16:39

这个页面对您有帮助吗？

有用

无用

ByteHouse 企业版

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码