本接口用于创建 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_data |
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
PackageType | string | 是 | 实例系列:
| official |
PayType | string | 是 | 付费类型:
| prePaid |
VpcId | string | 是 | VPC ID。 | vpc-bp1fll2mci6d7pw8m**** |
PricingCycle | string | 否 | 购买时长单位:
| Month |
VSwitches | array<object> | 否 | 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> | 否 | 实例标签。 | |
object | 否 | 标签结构体。 | ||
Key | string | 否 | 标签键。 | k1 |
Value | string | 否 | 标签值。 | v1 |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-aekzllkih7jqxxx |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。 | 123e4567-e89b-12d3-a456-426655440000 |
ObserverNodeGroups | array<object> | 否 | 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<object> | 否 | 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 | 否 | 云盘的性能级别。包含以下取值:
| pl1 |
diskNumber | integer | 否 | 磁盘数量。 | 1 |
residentNodeNumber | integer | 否 | 节点数量。 | 3 |
specType | string | 否 | 计算组规格类型。包括以下类型:
| standard |
localStorageInstanceType | string | 否 | 节点组本地 SSD 实例规格, 仅在基于 Ecs 实例且 SpecType 为本地 SSD/大规格存储时该值才有意义。 | local_ssd_4_4xlarge |
zoneId | string | 否 | 可用区 ID。 | cn-hangzhou-i |
FrontendNodeGroups | array<object> | 否 | 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**** |
返回参数
示例
正常返回示例
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"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-09-12 | API 内部配置变更,不影响调用 | 查看变更详情 |
2025-07-30 | API 内部配置变更,不影响调用 | 查看变更详情 |