Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Creating a StarRocks Instance

Function

This API is used to create a StarRocks instance. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/starrocks

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

TaurusDB instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Content-Type

Yes

String

Content type. Value: application/json

X-Language

No

String

Request language type. The default value is en-us. Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Instance name. Instances of the same type can have the same name under the same tenant.

The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

engine

Yes

engine object

Engine information.

ha

Yes

ha object

Deployment information.

fe_flavor_id

Yes

String

Specification ID of the frontend node. You can use the value of id in the response to querying HTAP specifications.

be_flavor_id

Yes

String

Specification ID of the backend node. You can use the value of id in the response to querying HTAP specifications.

db_root_pwd

Yes

String

Database password.

The password must meet the following requirements:

  • The password contains at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters ~!@#$%^*-_=+?,()&|.,
  • The password consists of 8 to 32 characters.
  • You are advised to enter a strong password to improve security and prevent security risks such as brute force cracking. If you enter a weak password, the system automatically determines that the password is invalid.

fe_count

Yes

Integer

Number of frontend nodes.

  • The value is fixed to 1 for a single-node instance.
  • For a cluster instance, the value ranges from 3 to 10.

be_count

Yes

Integer

Number of backend nodes.

  • The value is fixed to 1 for a single-node instance.
  • For a cluster instance, the value ranges from 3 to 10.

az_mode

Yes

String

AZ type. Currently, only single AZ is supported.

Enumerated value: single

fe_volume

Yes

fe_volume object

Storage information of the frontend node.

be_volume

Yes

be_volume object

Storage information of the backend node.

az_code

Yes

String

AZ code.

time_zone

No

String

Time zone. The default time zone is UTC+08:00.

tags_info

Yes

tags_info object

Tag information.

Table 4 engine

Parameter

Mandatory

Type

Description

type

Yes

String

Engine type. Only StarRocks is supported.

version

Yes

String

Major version number of the engine.

Table 5 ha

Parameter

Mandatory

Type

Description

mode

Yes

String

Deployment mode.

Enumerated values:

  • Single
  • Cluster
Table 6 fe_volume

Parameter

Mandatory

Type

Description

io_type

Yes

String

Storage type. The value can be obtained from the response to querying HTAP engine resources.

capacity_in_gb

Yes

Integer

Storage space in GB. Increment: 10 GB

  • Minimum value: 50
  • Maximum value: 1000
Table 7 be_volume

Parameter

Mandatory

Type

Description

io_type

Yes

String

Storage type. The value can be obtained from the response to querying HTAP engine resources.

capacity_in_gb

Yes

Integer

Storage space in GB. Increment: 10 GB

  • Minimum value: 50
  • Maximum value: 32000
Table 8 tags_info

Parameter

Mandatory

Type

Description

sys_tags

Yes

Array of sys_tags objects

System tags.

Table 9 sys_tags

Parameter

Mandatory

Type

Description

key

Yes

String

Tag key.

Enumerated value: _sys_enterprise_project_id

value

Yes

String

Tag value.

Enumerated value: 0

Response Parameters

Status code: 201

Table 10 Response body parameters

Parameter

Type

Description

instance

instance object

Instance information.

job_id

String

Workflow ID.

Table 11 instance

Parameter

Type

Description

id

String

StarRocks instance ID, which is compliant with the UUID format.

az_code

String

AZ code.

az_mode

String

AZ type.

Values:

  • single: single AZ
  • multi: multiple AZs

name

String

Instance name.

engine

engine object

Engine information.

vpc_id

String

VPC ID.

security_group_id

String

Security group ID.

sub_net_id

String

Subnet ID.

db_user

String

Database user. The default value is root.

port

Integer

Database port number. The default value is 3306.

ha_mode

String

Deployment mode.

pay_info

pay_info object

Billing information.

enable_ssl

Boolean

Whether to enable SSL.

status

String

Instance status.

region

String

Region where the instance is deployed.

tags_info

tags_info object

Instance tags.

Table 12 engine

Parameter

Type

Description

type

String

Engine type.

version

String

Major version number of the engine.

Table 13 pay_info

Parameter

Type

Description

pay_model

String

Billing mode.

  • 0: pay-per-use
  • 1: yearly/monthly

StarRocks instances support only pay-per-use billing. The default value is 0.

order_id

String

Yearly/monthly order ID.

period

String

Yearly/monthly subscription period.

period_type

String

Subscription period type.

is_auto_renew

String

Whether to automatically renew the yearly/monthly subscription.

Table 14 tags_info

Parameter

Type

Description

tags

Array of tags objects

User tags. This parameter is left blank by default.

sys_tags

Array of sys_tags objects

System tags.

Table 15 tags

Parameter

Type

Description

key

String

Tag key.

value

String

Tag value.

Table 16 sys_tags

Parameter

Type

Description

key

String

Tag key.

value

String

Tag value.

Status code: 400

Table 17 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 18 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Creating a DB instance

POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/40dc4c5729f14aad893e2dcd5baf6a15in07/starrocks

{
  "name" : "htap-ff64",
  "engine" : {
    "type" : "star-rocks",
    "version" : "3.1"
  },
  "ha" : {
    "mode" : "Single"
  },
  "fe_flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a",
  "be_flavor_id" : "de565db8-0a96-37ea-9388-61167624712c",
  "db_root_pwd" : "Test@123!",
  "fe_count" : 1,
  "be_count" : 1,
  "az_mode" : "single",
  "fe_volume" : {
    "io_type" : "SSD",
    "capacity_in_gb" : 50
  },
  "be_volume" : {
    "io_type" : "SSD",
    "capacity_in_gb" : 50
  },
  "az_code" : "az",
  "time_zone" : "UTC+08:00",
  "tags_info" : {
    "sys_tags" : [ {
      "key" : "_sys_enterprise_project_id",
      "value" : "0"
    } ]
  }
}

Example Response

Status code: 201

Success.

{
  "instance" : {
    "id" : "590031445ef845bb912d7fc8243db80cin17",
    "az_code" : "az1",
    "az_mode" : "single",
    "name" : "htap-ff64",
    "engine" : {
      "type" : "star-rocks",
      "version" : "3.1"
    },
    "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0",
    "security_group_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1",
    "sub_net_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b",
    "db_user" : "root",
    "port" : 3306,
    "ha_mode" : "Single",
    "pay_info" : {
      "pay_model" : "0",
      "order_id" : null,
      "period" : null,
      "period_type" : null,
      "is_auto_renew" : null
    },
    "enable_ssl" : false,
    "status" : "creating",
    "region" : "az",
    "tags_info" : {
      "tags" : [ ],
      "sys_tags" : [ {
        "key" : "_sys_enterprise_project_id",
        "value" : "0"
      } ]
    }
  },
  "job_id" : "cf0b7506-1505-450f-9d95-ce9d93b6b5c3"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback