更新时间:2025-09-09 GMT+08:00

创建StarRocks实例

功能介绍

创建StarRocks实例。

URI

POST /v3/{project_id}/instances/{instance_id}/starrocks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释

TaurusDB数据库实例ID,严格匹配UUID规则。

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,后缀为in07,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

Content-Type

String

参数解释

内容类型。

约束限制

不涉及。

取值范围

application/json。

默认取值

application/json。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释

实例名称。同一租户下,同类型的实例名可重名。

约束限制

不涉及。

取值范围

最小为4个字符,最大为64个字符且不超过64个字节,必须以字母开头,区分大小写,可以包含字母、数字、中划线、下划线,不能包含其他特殊字符。不支持中文名。

默认取值

不涉及。

engine

engine object

参数解释

引擎信息。

约束限制

不涉及。

ha

ha object

参数解释

部署信息。

约束限制

不涉及。

fe_flavor_id

String

参数解释

FE节点规格ID。可通过调用HTAP查询规格信息接口,获取响应消息中的“id”。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

be_flavor_id

String

参数解释

BE节点规格ID。可通过调用HTAP查询规格信息接口,获取响应消息中的“id”。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

db_root_pwd

String

参数解释

数据库密码。

约束限制

不涉及。

取值范围

至少包含以下字符的三种:大小写字母、数字和特殊符号~!@#$%^*-_=+?,()&|.,长度8~32个字符。 建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。如果您输入弱密码,系统会自动判定密码非法。

默认取值

不涉及。

fe_count

Integer

参数解释

FE节点数。

约束限制

不涉及。

取值范围

  • 单机时固定为1。

  • 集群时取值[3, 10]。

默认取值

不涉及。

be_count

Integer

参数解释

BE节点数。

约束限制

不涉及。

取值范围

  • 单机时固定为1。

  • 集群时取值[3, 10]。

默认取值

不涉及。

az_mode

String

参数解释

可用区类型。

取值范围

当前仅支持single。

fe_volume

fe_volume object

FE节点存储规格。

be_volume

be_volume object

BE节点存储规格。

az_code

String

可用区代码。

time_zone

String

参数解释

时区。

取值范围

默认时区为UTC+08:00。

tags_info

tags_info object

标签信息。

security_group_id

String

参数解释

实例安全组ID。默认与TaurusDB实例的安全组ID一致。

取值范围

不涉及。

pay_info

pay_info object

支付信息。包周期场景必填。

region_code

String

可用区。包周期场景必填。

表4 engine

参数

是否必选

参数类型

描述

type

String

参数解释

引擎类型。

约束限制

不涉及。

取值范围

仅支持star-rocks。

默认取值

不涉及。

version

String

参数解释

引擎大版本号,可通过调用HTAP引擎资源查询接口获取。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表5 ha

参数

是否必选

参数类型

描述

mode

String

参数解释

部署模式。

约束限制

不涉及。

取值范围

  • Single:单机。

  • Cluster: 集群。

默认取值

不涉及。

表6 fe_volume

参数

是否必选

参数类型

描述

io_type

String

磁盘类型。通过HTAP引擎资源查询返回消息获取。

capacity_in_gb

Integer

参数解释

磁盘容量,单位GB

增长的步长:10GB

取值范围

不涉及。

表7 be_volume

参数

是否必选

参数类型

描述

io_type

String

磁盘类型。通过调用HTAP引擎资源查询接口获取。

capacity_in_gb

Integer

参数解释

磁盘容量,单位GB。

增长的步长:10GB。

取值范围

不涉及。

表8 tags_info

参数

是否必选

参数类型

描述

sys_tags

Array of sys_tags objects

系统标签。

表9 sys_tags

参数

是否必选

参数类型

描述

key

String

标签键。

value

String

标签值。

表10 pay_info

参数

是否必选

参数类型

描述

pay_model

String

参数解释

计费模式,默认0。包周期场景必填。

取值范围

  • 0:按需计费

  • 1:包周期

period

String

包周期周期。包周期场景必填。

period_type

String

参数解释

包周期周期类型。包周期场景必填。

取值范围

  • 2:包月

  • 3:包年

is_auto_renew

String

参数解释

包周期是否自动续费。包周期场景必填。

取值范围

  • 1:自动续费

  • 0:不自动续费

响应参数

状态码: 201

表11 响应Body参数

参数

参数类型

描述

instance

instance object

实例信息。

job_id

String

工作流ID。

表12 instance

参数

参数类型

描述

id

String

StarRocks实例ID,严格匹配UUID规则。

az_code

String

可用区码。

az_mode

String

参数解释

可用区模式。

取值范围

single:单可用区。

multi:多可用区。

name

String

实例名称。

engine

engine object

引擎信息。

vpc_id

String

虚拟私有云ID。

security_group_id

String

安全组ID。

sub_net_id

String

子网ID。

db_user

String

数据库用户,默认root。

port

Integer

数据库端口号,默认3306。

ha_mode

String

部署模式。

pay_info

pay_info object

计费信息。

enable_ssl

Boolean

SSL开关。

status

String

实例状态。

region

String

实例所在区域。

tags_info

tags_info object

实例标签。

表13 engine

参数

参数类型

描述

type

String

引擎类型。

version

String

引擎大版本号。

表14 pay_info

参数

参数类型

描述

pay_model

String

参数解释

计费模式。

取值范围

  • 0:按需计费

  • 1:包周期

默认取值

StarRocks实例当前只支持按需计费,默认值为0

order_id

String

包周期计费ID。

period

String

包周期周期。

period_type

String

包周期周期类型。

is_auto_renew

String

包周期是否自动续费。

表15 tags_info

参数

参数类型

描述

tags

Array of tags objects

用户标签,默认为空。

sys_tags

Array of sys_tags objects

系统标签。

表16 tags

参数

参数类型

描述

key

String

标签键。

value

String

标签值。

表17 sys_tags

参数

参数类型

描述

key

String

标签键。

value

String

标签值。

状态码: 400

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

创建数据库实例。

POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/40dc4c5729f14aad893e2dcd5baf6a15in07/starrocks

{
  "name" : "htap-ff64",
  "engine" : {
    "type" : "star-rocks",
    "version" : "3.1"
  },
  "ha" : {
    "mode" : "Single"
  },
  "fe_flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
  "be_flavor_id" : "de565db8-0a96-37ea-9388-61167624712c",
  "db_root_pwd" : "Test@123!",
  "fe_count" : 1,
  "be_count" : 1,
  "az_mode" : "single",
  "fe_volume" : {
    "io_type" : "SSD",
    "capacity_in_gb" : 50
  },
  "be_volume" : {
    "io_type" : "SSD",
    "capacity_in_gb" : 50
  },
  "az_code" : "az",
  "time_zone" : "UTC+08:00",
  "tags_info" : {
    "sys_tags" : [ {
      "key" : "_sys_enterprise_project_id",
      "value" : "0"
    } ]
  }
}

响应示例

状态码: 201

Success.

{
  "instance" : {
    "id" : "590031445ef845bb912d7fc8243db80cin17",
    "az_code" : "az1",
    "az_mode" : "single",
    "name" : "htap-ff64",
    "engine" : {
      "type" : "star-rocks",
      "version" : "3.1"
    },
    "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
    "security_group_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
    "sub_net_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
    "db_user" : "root",
    "port" : 3306,
    "ha_mode" : "Single",
    "pay_info" : {
      "pay_model" : "0",
      "order_id" : null,
      "period" : null,
      "period_type" : null,
      "is_auto_renew" : null
    },
    "enable_ssl" : false,
    "status" : "creating",
    "region" : "az",
    "tags_info" : {
      "tags" : [ ],
      "sys_tags" : [ {
        "key" : "_sys_enterprise_project_id",
        "value" : "0"
      } ]
    }
  },
  "job_id" : "cf0b7506-1505-450f-9d95-ce9d93b6b5c3"
}

状态码

请参见状态码

错误码

请参见错误码