文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（推荐）/ HTAP-标准版/ 创建StarRocks实例
更新时间：2024-09-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建StarRocks实例

功能介绍

创建StarRocks实例。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

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

instance_id

是

String

GaussDB(for MySQL)数据库实例ID，严格匹配UUID规则。

请求参数

表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。

枚举值：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

标签信息。
表4 engine

参数

是否必选

参数类型

描述

type

是

String

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

version

是

String

引擎大版本号。
表5 ha

参数

是否必选

参数类型

描述

mode

是

String

部署模式。

枚举值：

  • Single
  • Cluster
表6 fe_volume

参数

是否必选

参数类型

描述

io_type

是

String

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

capacity_in_gb

是

Integer

磁盘容量，单位GB。增长的步长：10GB。

  • 最小值：50
  • 最大值：1000
表7 be_volume

参数

是否必选

参数类型

描述

io_type

是

String

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

capacity_in_gb

是

Integer

磁盘容量，单位GB。增长的步长：10GB。

  • 最小值：50
  • 最大值：32000
表8 tags_info

参数

是否必选

参数类型

描述

sys_tags

是

Array of sys_tags objects

系统标签。
表9 sys_tags

参数

是否必选

参数类型

描述

key

是

String

标签键。

枚举值：_sys_enterprise_project_id

value

是

String

标签值。

枚举值：0

响应参数

状态码： 201

表10 响应Body参数

参数

参数类型

描述

instance

instance object

实例信息。

job_id

String

工作流ID。
表11 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

实例标签。
表12 engine

参数

参数类型

描述

type

String

引擎类型。

version

String

引擎大版本号。
表13 pay_info

参数

参数类型

描述

pay_model

String

计费模式。

  • 0：按需计费
  • 1：包周期

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

order_id

String

包周期计费ID。

period

String

包周期周期。

period_type

String

包周期周期类型。

is_auto_renew

String

包周期是否自动续费。
表14 tags_info

参数

参数类型

描述

tags

Array of tags objects

用户标签，默认为空。

sys_tags

Array of sys_tags objects

系统标签。
表15 tags

参数

参数类型

描述

key

String

标签键。

value

String

标签值。
表16 sys_tags

参数

参数类型

描述

key

String

标签键。

value

String

标签值。

状态码： 400

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表18 响应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"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： HTAP-标准版