DocsICP FilingConsole
官方文档
首页

CreateInstanceV1

更新时间：
复制 MD 格式
产品详情
我的收藏

Creates a Serverless StarRocks instance.

Operation description

Before you call this operation, make sure that you understand the billing methods and billable items of Serverless StarRocks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sr:CreateInstanceV1

create

*All Resource

*

 None None

Request syntax

POST /webapi/cluster/createV1 HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request body.

InstanceName

string

Yes

The name of the instance.

c1
AdminPassword

string

Yes

The administrator password for the instance.

password_example
Version

string

Yes

The major version of the instance.

3
AutoRenew

boolean

No

Specifies whether to enable auto-renewal. This parameter applies only when the payType is set to PrePaid. The default value is false.

true
RunMode

string

Yes

The run mode of the cluster:

  • Shared-nothing architecture (shared_nothing).

  • Shared-data architecture (shared_data).

shared_data
RegionId

string

Yes

The region ID.

cn-hangzhou
PackageType

string

Yes

The edition of the instance:

  • Trial (trial).

  • Standard (official).

official
PayType

string

Yes

The billing method:

  1. Subscription (prePaid).

  2. Pay-as-you-go (postPaid).

prePaid
VpcId

string

Yes

The ID of the VPC.

vpc-bp1fll2mci6d7pw8m****
PricingCycle

string

No

The unit of the subscription period. This parameter applies only when PayType is set to PrePaid. Valid values:

  • Month

  • Year

Month
VSwitches

array<object>

No

The VSwitches and their corresponding zones.

object

No

Information about a VSwitch.

VswId

string

Yes

The VSwitch ID.

vsw-bp19mlh98tm9teyyd****
ZoneId

string

No

The zone ID of the VSwitch.

cn-hangzhou-i
ZoneId

string

Yes

The primary zone ID.

cn-hangzhou-i
OssAccessingRoleName

string

No

The name of the RAM role used for password-free access to OSS.

AliyunEMRStarRocksAccessingOSSRole
Duration

integer

No

The length of the subscription period. This parameter applies only when PayType is set to PrePaid.

1
Tags

array<object>

No

A list of tags to attach to the instance.

object

No

A single tag, which consists of a key and a value.

Key

string

No

The tag key.

k1
Value

string

No

The tag value.

v1
ResourceGroupId

string

No

The ID of the resource group.

rg-aekzllkih7jqxxx
ClientToken

string

No

A client-generated token to ensure request idempotence. The token must be unique for each request, contain only ASCII characters, and be no more than 64 characters long.

123e4567-e89b-12d3-a456-426655440000
ObserverNodeGroups

array<object>

No

The observer compute groups. Use this parameter to enable multi-zone disaster recovery. The specifications of observer compute groups must match those of the FE node group.

object

No

The configuration of a single observer compute group.

cu

integer

No

The number of CUs. A CU (Compute Unit) is a basic unit of computing resources. 1 CU is equivalent to 1 vCPU and 4 GiB of memory.

8
storageSize

integer

No

The storage size in GiB.

100
storagePerformanceLevel

string

No

The performance level of the cloud disk. Only pl1 is supported, which provides up to 50,000 random read/write IOPS for a single disk.

pl1
diskNumber

integer

No

The number of cloud disks.

1
residentNodeNumber

integer

No

The number of nodes.

3
specType

string

No

The specification type of the compute group. Only Standard (standard) is supported.

standard
localStorageInstanceType

string

No

The instance type for local SSDs. This parameter does not apply to observer compute groups.

null
zoneId

string

No

The zone ID.

cn-hangzhou-i
BackendNodeGroups

array<object>

No

The BE or CN compute groups.

object

No

A single BE or CN compute group.

cu

integer

No

The number of CUs. A CU (Compute Unit) is a basic unit of computing resources. 1 CU is equivalent to 1 vCPU and 4 GiB of memory. If SpecType is set to ramEnhanced, 1 CU is equivalent to 1 vCPU and 8 GiB of memory.

8
storageSize

integer

No

The storage size in GiB.

100
storagePerformanceLevel

string

No

The performance level of the cloud disk. Valid values:

  • pl0: Up to 10,000 random read/write IOPS for a single disk.

  • pl1: Up to 50,000 random read/write IOPS for a single disk.

  • pl2: Up to 100,000 random read/write IOPS for a single disk.

  • pl3: Up to 1,000,000 random read/write IOPS for a single disk.

pl1
diskNumber

integer

No

The number of cloud disks.

1
residentNodeNumber

integer

No

The number of nodes.

3
specType

string

No

The specification type of the compute group. Valid values:

  • Standard (standard)

  • Local SSD (localSSD)

  • Big data storage (bigData)

  • Memory-enhanced (ramEnhanced)

  • Network-enhanced (networkEnhanced)

standard
localStorageInstanceType

string

No

The instance type for the local SSD of the node group. This parameter applies only to ECS-based instances when SpecType is localSSD or bigData.

local_ssd_4_4xlarge
zoneId

string

No

The zone ID.

cn-hangzhou-i
FrontendNodeGroups

array<object>

No

The FE node groups.

object

No

cu

integer

No

The number of CUs. A CU (Compute Unit) is a basic unit of computing resources. 1 CU is equivalent to 1 vCPU and 4 GiB of memory.

8
storageSize

integer

No

The storage size in GiB.

100
storagePerformanceLevel

string

No

The performance level of the cloud disk. Only pl1 is supported, which provides up to 50,000 random read/write IOPS for a single disk.

pl1
diskNumber

integer

No

The number of cloud disks.

1
residentNodeNumber

integer

No

The number of nodes.

3
specType

string

No

The specification type of the compute group. Only Standard (standard) is supported.

standard
localStorageInstanceType

string

No

The instance type for local SSDs. This parameter does not apply to FE node groups.

null
zoneId

string

No

The zone ID.

cn-hangzhou-i
PromotionOptionNo

string

No

The coupon ID.

165445235634
Encrypted

boolean

No

Specifies whether to enable encryption.

true
KmsKeyId

string

No

The ID of the Key Management Service (KMS) key.

fdsdf****
GatewayType

string

No

AgentNodeGroup

object

No

cu

integer

No

AutoPay

boolean

No

LinkedRamUserName

string

No

aliyun.test1
DlfCatalogName

string

No

paimon_test
DlfCatalogType

string

No

paimon
PrincipalType

string

No

RR
RamUserId

string

No

123456
EnableMultiAz

boolean

No

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200
RequestId

string

The request ID.

B67D142D-D54E-184F-A306-22BDC01B2XXX
Success

boolean

Indicates whether the request was successful.

true
ErrCode

string

The error code.

InvalidParams
ErrMessage

string

The error message.

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

object

The returned data.

OrderId

integer

The order ID.

241526000650XXX
InstanceId

string

The instance ID.

c-b25e21e243889XXX
AccessDeniedDetail

string

Details of the access denial.

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

Examples

Success response

JSON format

{
  "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\"   }"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.