CreateInstanceV1-阿里云帮助中心

This API is used to create a Serverless StarRocks instance.

Operation description

Before using this API, make sure you fully 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

Request syntax

POST /webapi/cluster/createV1 HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	Request body.
InstanceName	string	Yes	Instance name.	c1
AdminPassword	string	Yes	Instance administrator password.	password_example
Version	string	Yes	Instance major version.	3
AutoRenew	boolean	No	Whether to enable auto-renewal. This parameter is valid only when payType is PrePaid. Disabled by default.	true
RunMode	string	Yes	The running mode of the cluster: Shared-nothing (shared_nothing). Shared-data (shared_data).	shared_data
RegionId	string	Yes	Region ID.	cn-hangzhou
PackageType	string	Yes	Instance edition: Trial edition (trial). Standard edition (official).	official
PayType	string	Yes	Billing method: Subscription (prePaid). Pay-as-you-go (postPaid).	prePaid
VpcId	string	Yes	VPC ID.	vpc-bp1fll2mci6d7pw8m****
PricingCycle	string	No	Duration unit: Month (Month) Year (Year) This parameter is valid only when payType is PrePaid.	Month
VSwitches	array<object>	No	VSwitch and zone information.
	object	No	VSwitch information.
VswId	string	Yes	VSwitch ID.	vsw-bp19mlh98tm9teyyd****
ZoneId	string	No	Zone ID of the VSwitch.	cn-hangzhou-i
ZoneId	string	Yes	Primary zone ID.	cn-hangzhou-i
OssAccessingRoleName	string	No	The name of the role used for password-free access to OSS.	AliyunEMRStarRocksAccessingOSSRole
Duration	integer	No	Subscription duration. This parameter is valid only when payType is PrePaid.	1
Tags	array<object>	No	Instance tags.
	object	No	Tag structure.
Key	string	No	Tag key.	k1
Value	string	No	Tag value.	v1
ResourceGroupId	string	No	Resource group ID.	rg-aekzllkih7jqxxx
ClientToken	string	No	Ensures the idempotency of the request. Generate a parameter value from your client to ensure that the value is unique across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters.	123e4567-e89b-12d3-a456-426655440000
ObserverNodeGroups	array<object>	No	Observer node group information. Specify this field only when you need to enable multi-zone disaster recovery. The Observer configuration must be consistent with the FE node group specifications.
	object	No	Observer node group information.
cu	integer	No	Number of CUs. CU (Compute Unit) is the basic billing unit of the service. 1 CU = 1 CPU core + 4 GiB memory.	8
storageSize	integer	No	Storage size. Unit: GiB.	100
storagePerformanceLevel	string	No	Performance level of the cloud disk. Only pl1 is supported, with a maximum random read/write IOPS of 50,000 per disk.	pl1
diskNumber	integer	No	Number of disks.	1
residentNodeNumber	integer	No	Number of nodes.	3
specType	string	No	Node group specification type. Only standard is supported.	standard
localStorageInstanceType	string	No	Local SSD instance type. This field does not need to be set for the Observer node group.	null
zoneId	string	No	Zone ID.	cn-hangzhou-i
BackendNodeGroups	array<object>	No	BE or CN node group information.
	object	No	BE or CN node group information.
cu	integer	No	Number of CUs. CU (Compute Unit) is the basic billing unit of the service. 1 CU = 1 CPU core + 4 GiB memory. When SpecType is ramEnhanced, 1 CU = 1 CPU core + 8 GiB memory.	8
storageSize	integer	No	Storage size. Unit: GiB.	100
storagePerformanceLevel	string	No	Performance level of the cloud disk. Valid values: pl0: maximum random read/write IOPS of 10,000 per disk. pl1: maximum random read/write IOPS of 50,000 per disk. pl2: maximum random read/write IOPS of 100,000 per disk. pl3: maximum random read/write IOPS of 1,000,000 per disk.	pl1
diskNumber	integer	No	Number of disks.	1
residentNodeNumber	integer	No	Number of nodes.	3
specType	string	No	Node group specification type. Valid values: standard: Standard. localSSD: Local SSD. bigData: Big data storage. ramEnhanced: Memory enhanced. networkEnhanced: Network enhanced.	standard
localStorageInstanceType	string	No	Local SSD instance type of the node group. This parameter is valid only for ECS-based instances when SpecType is localSSD or bigData.	local_ssd_4_4xlarge
zoneId	string	No	Zone ID.	cn-hangzhou-i
FrontendNodeGroups	array<object>	No	FE node group information.
	object	No
cu	integer	No	Number of CUs. CU (Compute Unit) is the basic billing unit of the service. 1 CU = 1 CPU core + 4 GiB memory.	8
storageSize	integer	No	Storage size. Unit: GiB.	100
storagePerformanceLevel	string	No	Performance level of the cloud disk. Only pl1 is supported, with a maximum random read/write IOPS of 50,000 per disk.	pl1
diskNumber	integer	No	Number of disks.	1
residentNodeNumber	integer	No	Number of nodes.	3
specType	string	No	Node group specification type. Only standard is supported.	standard
localStorageInstanceType	string	No	Local SSD instance type. This field does not need to be set for the FE node group.	null
zoneId	string	No	Zone ID.	cn-hangzhou-i
PromotionOptionNo	string	No	Coupon ID.	165445235634
Encrypted	boolean	No	Whether to enable encryption.	true
KmsKeyId	string	No	KMS key ID.	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	HTTP status code.	200
RequestId	string	Request ID.	B67D142D-D54E-184F-A306-22BDC01B2XXX
Success	boolean	Whether the request is successful.	true
ErrCode	string	Error code.	InvalidParams
ErrMessage	string	Error message.	Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]
Data	object	Response data.
OrderId	integer	Order ID.	241526000650XXX
InstanceId	string	Instance ID.	c-b25e21e243889XXX
AccessDeniedDetail	string	Details of the permission verification failure.	{ "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.