CreateInstanceV1 - 创建实例

本接口用于创建 Serverless StarRocks 实例。

接口说明

请确保在使用该接口前,已充分了解 Serverless StarRocks 产品的收费方式和计费项

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sr:CreateInstanceV1

create

*全部资源

*

请求语法

POST /webapi/cluster/createV1 HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

请求结构体。

InstanceName

string

实例名称。

c1

AdminPassword

string

实例管理员密码。

password_example

Version

string

实例主版本。

3

AutoRenew

boolean

是否开启自动续费,仅在 payType 为 PrePaid 时有意义。默认不开启。

true

RunMode

string

集群的运行模式:

  • 存算一体(shared_nothing)。

  • 存算分离(shared_data)。

shared_data

RegionId

string

地域 ID。

cn-hangzhou

PackageType

string

实例系列:

  • 入门版(trial)。

  • 标准版(official)。

official

PayType

string

付费类型:

  1. 包年包月(prePaid)。

  2. 按量付费(postPaid)。

prePaid

VpcId

string

VPC ID。

vpc-bp1fll2mci6d7pw8m****

PricingCycle

string

购买时长单位:

  • 月(Month)

  • 年(Year)

仅在 payType 为 PrePaid 时有意义。

Month

VSwitches

array

VSwitch 信息和可用区信息。

object

交换机信息。

VswId

string

交换机 ID。

vsw-bp19mlh98tm9teyyd****

ZoneId

string

交换机可用区 ID。

cn-hangzhou-i

ZoneId

string

主可用区 ID。

cn-hangzhou-i

OssAccessingRoleName

string

用于免密访问 OSS 的角色名称。

AliyunEMRStarRocksAccessingOSSRole

Duration

integer

购买时长。仅在 payType 为 PrePaid 时有意义。

1

Tags

array

实例标签。

object

标签结构体。

Key

string

标签键。

k1

Value

string

标签值。

v1

ResourceGroupId

string

资源组 ID。

rg-aekzllkih7jqxxx

ClientToken

string

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。

123e4567-e89b-12d3-a456-426655440000

ObserverNodeGroups

array

Observer 计算组信息。仅在需要开启多可用区容灾时填写该字段,且 Observer 的配置必须和 FE 节点组的规格保持一致。

object

Observer 计算组信息。

cu

integer

CU 数量。CU (Compute Unit) 是服务的基本计量单元,1 CU=1 核 CPU+4GiB 内存。

8

storageSize

integer

存储大小。单位为 GiB。

100

storagePerformanceLevel

string

云盘的性能级别。仅支持 pl1,单盘最高随机读写 IOPS 5 万。

pl1

diskNumber

integer

磁盘数量。

1

residentNodeNumber

integer

节点数量。

3

specType

string

计算组规格类型。仅支持标准版(standard)。

standard

localStorageInstanceType

string

本地 SSD 实例规格,Observer 计算组无需设置该字段。

null

zoneId

string

可用区 ID。

cn-hangzhou-i

BackendNodeGroups

array

BE 或者 CN 计算组信息。

object

BE 或者 CN 计算组信息。

cu

integer

CU 数量。CU (Compute Unit) 是服务的基本计量单元,1 CU=1 核 CPU+4GiB 内存,仅在 SpecType 为内存增强型时 1 CU=1 核 CPU+8GiB 内存。

8

storageSize

integer

存储大小。单位为 GiB。

100

storagePerformanceLevel

string

云盘的性能级别。包含以下取值:

  • pl0:单盘最高随机读写 IOPS 1 万。

  • pl1:单盘最高随机读写 IOPS 5 万。

  • pl2:单盘最高随机读写 IOPS 10 万。

  • pl3:单盘最高随机读写 IOPS 100 万。

pl1

diskNumber

integer

磁盘数量。

1

residentNodeNumber

integer

节点数量。

3

specType

string

计算组规格类型。包括以下类型:

  • standard,标准版。

  • localSSD ,本地 SSD。

  • bigData,大规格存储。

  • ramEnhanced,内存增强型。

  • networkEnhanced,网络增强型。

standard

localStorageInstanceType

string

节点组本地 SSD 实例规格, 仅在基于 Ecs 实例且 SpecType 为本地 SSD/大规格存储时该值才有意义。

local_ssd_4_4xlarge

zoneId

string

可用区 ID。

cn-hangzhou-i

FrontendNodeGroups

array

FE 节点组信息。

object

cu

integer

CU 数量。CU (Compute Unit) 是服务的基本计量单元,1 CU=1 核 CPU+4GiB 内存。

8

storageSize

integer

存储大小。单位为 GiB。

100

storagePerformanceLevel

string

云盘的性能级别。仅支持 pl1,单盘最高随机读写 IOPS 5 万。

pl1

diskNumber

integer

磁盘数量。

1

residentNodeNumber

integer

节点数量。

3

specType

string

计算组规格类型。仅支持标准版(standard)。

standard

localStorageInstanceType

string

本地 SSD 实例规格,FE 计算组无需设置该字段。

null

zoneId

string

可用区 ID。

cn-hangzhou-i

PromotionOptionNo

string

优惠券 ID。

165445235634

Encrypted

boolean

是否加密。

true

KmsKeyId

string

KMS 密钥 ID。

fdsdf****

GatewayType

string

AgentNodeGroup

object

cu

integer

AutoPay

boolean

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 请求状态码。

200

RequestId

string

请求 ID。

B67D142D-D54E-184F-A306-22BDC01B2XXX

Success

boolean

请求是否成功。

true

ErrCode

string

错误码。

InvalidParams

ErrMessage

string

错误信息。

Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]

Data

object

返回数据。

OrderId

integer

订单 ID。

241526000650XXX

InstanceId

string

实例 ID。

c-b25e21e243889XXX

AccessDeniedDetail

string

权限校验失败详情。

{ "PolicyType": "AccountLevelIdentityBasedPolicy", "AuthPrincipalOwnerId": "xxx", "EncodedDiagnosticMessage": "xxx", "AuthPrincipalType": "xxx", "AuthPrincipalDisplayName": "xxx", "NoPermissionType": "ImplicitDeny", "AuthAction": "sr:xxx" }

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "B67D142D-D54E-184F-A306-22BDC01B2XXX",
  "Success": true,
  "ErrCode": "InvalidParams",
  "ErrMessage": "Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]",
  "Data": {
    "OrderId": 0,
    "InstanceId": "c-b25e21e243889XXX"
  },
  "AccessDeniedDetail": "{     \"PolicyType\": \"AccountLevelIdentityBasedPolicy\",     \"AuthPrincipalOwnerId\": \"xxx\",     \"EncodedDiagnosticMessage\": \"xxx\",     \"AuthPrincipalType\": \"xxx\",     \"AuthPrincipalDisplayName\": \"xxx\",     \"NoPermissionType\": \"ImplicitDeny\",     \"AuthAction\": \"sr:xxx\"   }"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情