云数据库 TAURUSDB-创建StarRocks实例:请求参数

时间:2024-12-11 17:00:06

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

Content-Type

String

内容类型。 取值:application/json。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us

  • zh-cn

表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。默认与Taurus安全组ID一致。

pay_info

pay_info object

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

region_code

String

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

表4 engine

参数

是否必选

参数类型

描述

type

String

引擎类型。仅支持star-rocks。

version

String

引擎大版本号。

表5 ha

参数

是否必选

参数类型

描述

mode

String

部署模式。

表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:不自动续费

support.huaweicloud.com/api-gaussdbformysql/CreateStarrocksInstance.html