创建StarRocks实例 - CreateStarrocksInstance

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

instance_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

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。

name

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

engine

是

engine object

参数解释：

引擎信息。

约束限制：

不涉及。

ha

是

ha object

参数解释：

部署信息。

约束限制：

不涉及。

fe_flavor_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

be_flavor_id

是

String

参数解释：

BE节点规格ID。可通过调用HTAP查询规格信息 - ListHtapFlavor接口，获取响应消息中的“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

参数解释：

可用区。

约束限制：

包周期场景必填。

取值范围：

不涉及。

默认取值：

不涉及。

type

是

String

参数解释：

引擎类型。

约束限制：

不涉及。

取值范围：

仅支持star-rocks。

默认取值：

不涉及。

version

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

mode

是

String

参数解释：

部署模式。

约束限制：

不涉及。

取值范围：

• Single：单机。

• Cluster: 集群。

默认取值：

不涉及。

io_type

是

String

参数解释：

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

约束限制：

不涉及。

capacity_in_gb

是

Integer

参数解释：

磁盘容量，单位GB。

约束限制：

增长的步长：10GB。

取值范围：

50 - 1000。

默认取值：

不涉及。

io_type

是

String

参数解释：

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

约束限制：

不涉及。

capacity_in_gb

是

Integer

参数解释：

磁盘容量，单位GB。

约束限制：

增长的步长：10GB。

取值范围：

50 - 1000。

默认取值：

不涉及。

sys_tags

是

Array of sys_tags objects

系统标签。

key

是

String

标签键。

value

是

String

标签值。

pay_model

否

String

参数解释：

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

取值范围：

• 0：按需计费

• 1：包周期

period

否

String

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

period_type

否

String

参数解释：

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

取值范围：

• 2：包月

• 3：包年

is_auto_renew

否

String

参数解释：

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

取值范围：

• 1：自动续费

• 0：不自动续费

instance

instance object

实例信息。

job_id

String

工作流ID。

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

实例标签。

type

String

引擎类型。

version

String

引擎大版本号。

pay_model

String

参数解释：

计费模式。

取值范围：

• 0：按需计费

• 1：包周期

默认取值：

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

order_id

String

包周期计费ID。

period

String

包周期周期。

period_type

String

包周期周期类型。

is_auto_renew

String

包周期是否自动续费。

tags

Array of tags objects

用户标签，默认为空。

sys_tags

Array of sys_tags objects

系统标签。

key

String

标签键。

value

String

标签值。

key

String

标签键。

value

String

标签值。

error_code

String

错误码。

error_msg

String

错误消息。

error_code

String

错误码。

error_msg

String

错误消息。