CreateInstanceV1 - E-MapReduce - Alibaba Cloud Documentation Center

Creates a Serverless StarRocks instance.

Operation description

Before you call this operation, make sure that you understand the billing methods and billable items for 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	The request body.
InstanceName	string	Yes	The instance name.	c1
AdminPassword	string	Yes	The password of the administrator account 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 is valid only if you set `PayType` to `PrePaid`. Default value: false.	true
RunMode	string	Yes	The run mode of the instance. Valid values: shared_nothing: The storage and compute resources are integrated. shared_data: The storage and compute resources are separated.	shared_data
RegionId	string	Yes	The region ID.	cn-hangzhou
PackageType	string	Yes	The edition of the instance. Valid values: trial: Trial Edition. official: Standard Edition.	official
PayType	string	Yes	The billing method. Valid values: Subscription (prepaid). Pay-as-you-go (postpaid).	prePaid
VpcId	string	Yes	The ID of the VPC.	vpc-bp1fll2mci6d7pw8m****
PricingCycle	string	No	The unit of the subscription duration. This parameter is required only if you set `PayType` to `PrePaid`. Valid values: Month Year	Month
VSwitches	array<object>	No	The vSwitches and zones.
	object	No	The vSwitch.
VswId	string	Yes	The ID of the vSwitch.	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 that is used to access OSS without a password.	AliyunEMRStarRocksAccessingOSSRole
Duration	integer	No	The subscription duration. This parameter is required only if you set `PayType` to `PrePaid`.	1
Tags	array<object>	No	The tags of the instance.
	object	No	The tag.
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	The client token that is used to ensure the idempotence of the request. Make sure that the token is unique for each request. The token can contain only ASCII characters and cannot exceed 64 characters in length.	123e4567-e89b-12d3-a456-426655440000
ObserverNodeGroups	array<object>	No	The observer compute groups. Specify this parameter only to enable multi-zone disaster recovery. The configurations of the observer compute groups must be the same as the specifications of the frontend (FE) node group.
	object	No	The observer compute group.
cu	integer	No	The number of compute units (CUs). A CU is a basic unit of computing resources. One CU is equivalent to 1 CPU core and 4 GiB of memory.	8
storageSize	integer	No	The storage capacity in GiB.	100
storagePerformanceLevel	string	No	The performance level (PL) of the disk. Only PL1 is supported. A single PL1 disk provides up to 50,000 random read/write input/output operations per second (IOPS).	pl1
diskNumber	integer	No	The number of disks.	1
residentNodeNumber	integer	No	The number of nodes.	3
specType	string	No	The specification type of the compute group. Only Standard Edition (`standard`) is supported.	standard
localStorageInstanceType	string	No	The instance type of the local SSD. You do not need to set this parameter for observer compute groups.	null
zoneId	string	No	The ID of the zone.	cn-hangzhou-i
BackendNodeGroups	array<object>	No	The backend (BE) or compute node (CN) compute groups.
	object	No	The BE or CN compute group.
cu	integer	No	The number of CUs. A CU is a basic unit of computing resources. One CU is equivalent to 1 CPU core and 4 GiB of memory. If you set `SpecType` to `ramEnhanced`, one CU is equivalent to 1 CPU core and 8 GiB of memory.	8
storageSize	integer	No	The storage capacity in GiB.	100
storagePerformanceLevel	string	No	The PL of the disk. Valid values: pl0: A single disk provides up to 10,000 random read/write IOPS. pl1: A single disk provides up to 50,000 random read/write IOPS. pl2: A single disk provides up to 100,000 random read/write IOPS. pl3: A single disk provides up to 1,000,000 random read/write IOPS.	pl1
diskNumber	integer	No	The number of disks.	1
residentNodeNumber	integer	No	The number of nodes.	3
specType	string	No	The specification type of the compute group. Valid values: standard: Standard Edition. localSSD: local SSD. bigData: big data storage. ramEnhanced: memory-enhanced. networkEnhanced: network-enhanced.	standard
localStorageInstanceType	string	No	The instance type of the local SSD for the compute group. This parameter is valid only for Elastic Compute Service (ECS)-based instances if you set `SpecType` to `localSSD` or `bigData`.	local_ssd_4_4xlarge
zoneId	string	No	The ID of the zone.	cn-hangzhou-i
FrontendNodeGroups	array<object>	No	The FE node group.
	object	No
cu	integer	No	The number of CUs. A CU is a basic unit of computing resources. One CU is equivalent to 1 CPU core and 4 GiB of memory.	8
storageSize	integer	No	The storage capacity in GiB.	100
storagePerformanceLevel	string	No	The PL of the disk. Only PL1 is supported. A single PL1 disk provides up to 50,000 random read/write IOPS.	pl1
diskNumber	integer	No	The number of disks.	1
residentNodeNumber	integer	No	The number of nodes.	3
specType	string	No	The specification type of the compute group. Only Standard Edition (`standard`) is supported.	standard
localStorageInstanceType	string	No	The instance type of the local SSD. You do not need to set this parameter for FE compute groups.	null
zoneId	string	No	The ID of the zone.	cn-hangzhou-i
PromotionOptionNo	string	No	The coupon ID.	165445235634
Encrypted	boolean	No	Specifies whether to encrypt the data.	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

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	B67D142D-D54E-184F-A306-22BDC01B2XXX
Success	boolean	Indicates whether the request was successful.	true
ErrCode	string	The error code returned.	InvalidParams
ErrMessage	string	The error message returned.	Invalid params: [Region id should be select from set [cn-beijing, cn-hangzhou]]
Data	object	The data returned.
OrderId	integer	The ID of the order.	241526000650XXX
InstanceId	string	The ID of the instance.	c-b25e21e243889XXX
AccessDeniedDetail	string	The details that are returned when the access is denied.	{ "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.