Creating a Cluster (V2)

project_id

Yes

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

cluster

Yes

CreateClusterBody object

Cluster object.

name

Yes

String

Cluster name It can contain 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

backupStrategy

No

CreateClusterBackupStrategyBody object

Automatic snapshot creation.

The automatic snapshot creation policy is enabled only if backupStrategy is not left blank.

roles

Yes

Array of CreateClusterRolesBody objects

Cluster information

nics

Yes

CreateClusterInstanceNicsBody object

Subnet ID.

enterprise_project_id

No

String

Enterprise project ID. When creating a cluster, associate the enterprise project ID with the cluster. The value can contain a maximum of 36 characters. It is string 0 or in UUID format with hyphens (-). Value 0 indicates the default enterprise project.

tags

No

Array of CreateClusterTagsBody objects

Cluster tag.

availability_zone

Yes

String

One or more AZs. You need to specify the AZ names.

By default, a single AZ is specified. If multiple AZs are specified, use commas (,) to separate different AZ names. For example, if three AZs are selected under region-1, the value of availability_zone is region-1a,region-1b,region-1c. If a single AZ is used, the value of availability_zone is empty by default.

NOTE:

Note:

- If multiple AZs are selected, the name of each AZ must be unique, and the number of nodes must be greater than or equal to the number of AZs.

- If the number of nodes is a multiple of the number of AZs, the nodes are evenly distributed to each AZ.

• If the number of nodes is not a multiple of the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most.

• Obtain the AZ names from Regions and Endpoints in section "Before You Start".

datastore

Yes

CreateClusterDatastoreBody object

Engine type. Its value can be elasticsearch, opensearch, or logstash.

authorityEnable

No

Boolean

Whether to enable authentication. The value can be true or false. Authentication is disabled by default.

• true: Authentication is enabled for the cluster.

• false: Authentication is disabled for the cluster.

This parameter is supported in clusters 6.5.4 or later.

httpsEnable

No

Boolean

Whether communication is encrypted on the cluster. The value can be true or false. By default, communication encryption is disabled. When httpsEnable is set to true, authorityEnable must be set to true.- true: Communication is encrypted on the cluster.- false: Communication is not encrypted for the cluster.This parameter is supported in clusters 6.5.4 or later.

adminPwd

No

String

Password of the cluster user admin in security mode. This parameter is mandatory only when authorityEnable is set to true. Input requirements:

• Must contain 8 to 32 characters.

• Must contain at least three of the following character types: letters, digits, and special characters ~!@#$%^&*()-_=+\|[{}];:,<.>/?

publicIPReq

No

CreateClusterPublicIpReq object

Public network access information. This parameter is valid only when httpsEnable is set to true.

loadBalance

No

CreateClusterLoadBalance object

VPC endpoint service information

publicKibanaReq

No

CreateClusterPublicKibanaReq object

Kibana public network access information. This parameter is valid only when authorityEnable is set to true.

payInfo

No

PayInfoBody object

Parameters used for purchasing a yearly/monthly cluster.

ipv6_enable

No

Boolean

Whether to enable automatic IPv6 address assignment for the cluster. The default value is false.

diskEncryption

No

diskEncryptionInfo object

Disk encryption information.

period

Yes

String

Time when a snapshot is generated every day. Snapshots can only be generated on the hour. The format is HH:mm z: HH:mm refers to the hour time and z refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.

NOTE:

The default value is 00:00 GMT+08:00. When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.

frequency

No

String

Frequency of automatically creating snapshots.

NOTE:

The default value is DAY. If this parameter is set to HOUR, the scheduled task is executed every hour. If this parameter is set to DAY, the scheduled task is executed every day. If this parameter is set to SUN, MON, TUE, WED, THU, FRI or SAT, the scheduled task is executed at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday. The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.

prefix

Yes

String

Prefix of a snapshot that is automatically created, which is manually entered. Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.

keepday

Yes

Integer

Set the number of retained snapshots. The value ranges from 1 to 90. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to automated snapshots that are executed at the same frequency as the current automatic snapshot creation policy.

bucket

No

String

Name of the OBS bucket used for backup.

basePath

No

String

Storage path of the snapshot in the OBS bucket.

agency

No

String

IAM agency used to access OBS.

If none of the bucket, base_path, and agency parameters are specified, the system will automatically create an OBS bucket and an IAM agency. If the creation fails, you need to manually configure correct parameters.

maxSnapshotBytesPerSeconds

No

String

Parameter description:

Configure the maximum backup rate (per second) of each node. When the backup rate exceeds the value, traffic is limited to prevent high resource usage and system stability. The actual backup rate may not reach this value. It is affected by OBS and disks.

Constraints:

N/A

Value range:

There are three filling rules:

• Number + Unit

The number ranges from 0 to 9999.

The unit can be k, kb, m, mb, g, gb, t, tb, p, pb or b, which is case insensitive.

If the value is set to 0mb, the backup rate is not limited. If the backup rate is too high, the backup may occupy too many resources, affecting system stability. Exercise caution when setting this parameter.

• 0

• -1

Indicates that the backup rate is not limited. If the backup rate is too high, the backup may occupy too many resources, affecting system stability. Exercise caution when setting this parameter.

Indicates that the backup rate is not limited. If the backup rate is too high, the backup may occupy too many resources, affecting system stability. Exercise caution when setting this parameter.

Default value:

The default value is 40 MB. If no value is specified, the default value is used.

maxRestoreBytesPerSeconds

No

String

Parameter description:

Configure the maximum recovery rate (per second) of each node. When the recovery rate exceeds the value of this parameter, traffic is limited to prevent high resource usage and system stability. The actual restoration speed may not reach this value. It is affected by OBS and disks.

Constraints:

For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery rate is also limited by the indices.recovery.max_bytes_per_sec parameter. If the value of Max. recovery rate (per second) is less than the value of indices.recovery.max_bytes_per_sec, traffic is limited when the recovery rate reaches the value of Max. recovery rate (per second). If the value of Maximum recovery rate (per second) is greater than the value of indices.recovery.max_bytes_per_sec, traffic is limited when the recovery rate reaches the value of indices.recovery.max_bytes_per_sec.

Value range:

There are three filling rules:

• Number + Unit

The number ranges from 0 to 9999.

The unit can be k, kb, m, mb, g, gb, t, tb, p, pb or b, which is case insensitive.

If this parameter is set to 0mb, the restoration rate is not limited. However, for OpenSearch clusters and Elasticsearch clusters of version 7.6.2 or later, the restoration rate is also limited by the value of indices.recovery.max_bytes_per_sec. If the restoration rate is too high, the restoration may occupy too many resources, affecting system stability. Exercise caution when setting this parameter.

• 0

• -1

The restoration speed is not limited. However, the restoration speed of OpenSearch clusters and Elasticsearch clusters of version 7.6.2 or later is limited by the indices.recovery.max_bytes_per_sec parameter. If the restoration speed is too high, the restoration may occupy too many resources, affecting system stability. Exercise caution when setting this parameter.

The restoration speed is not limited. However, the restoration speed of OpenSearch clusters and Elasticsearch clusters of version 7.6.2 or later is limited by the indices.recovery.max_bytes_per_sec parameter. If the restoration speed is too high, the restoration may occupy too many resources, affecting system stability. Exercise caution when setting this parameter.

Default value:

For Elasticsearch clusters of version 7.6.2 or earlier, the default value is 40 MB.

For OpenSearch clusters and Elasticsearch clusters of version 7.6.2 or later, the default value is not limited, but the value is also limited by the indices.recovery.max_bytes_per_sec parameter.

If no value is specified, the default value is used.

flavorRef

Yes

String

Instance flavor. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List.

volume

Yes

CreateClusterInstanceVolumeBody object

Volume information. If flavorRef is set to a local disk flavor, leave this parameter blank. Obtain the the local disk flavor by referring to the diskrange attribute in Obtaining the Instance Specifications List. Currently, the following local disk flavors are supported:

• ess.spec-i3small

• ess.spec-i3medium

• ess.spec-i3.8xlarge.8

• ess.spec-ds.xlarge.8

• ess.spec-ds.2xlarge.8

• ess.spec-ds.4xlarge.8

type

Yes

String

• ess-master indicates a master node.

• ess-client indicates a client node.

• ess-cold indicates a cold data node.

• ess indicates a data node.

• lgs indicates a Logstash node.

• english indicates an English language model.

• arabic indicates an Arabic model.

• thai indicates a Thai model.

• turkish indicates a Turkish language model.

• tools indicates a tools model.] (tag:white)

[- chinese indicates a Chinese language model.

instanceNum

Yes

Integer

Number of instances.

• If ess is selected, you can set the value to 1 to 32.

  • If both ess and ess-master are selected, you can set the value to 1 to 200.

  • If both ess and ess-client are selected, you can set the value to 1 to 32.

  • If both ess and ess-cold are selected, you can set the value to 32.

• If ess-master is selected, you can set the value to 3 to 10.

• If ess-client is selected, you can set the value to 1 to 32.

• If ess-cold is selected, you can set the value to 1 to 32.

volume_type

Yes

String

Volume type

• COMMON: common I/O

• HIGH: high I/O

• ULTRAHIGH: ultra-high I/O

• ESSD: ultra-fast SSD

size

Yes

Integer

Volume size. The value must be greater than 0 and a multiple of 4 and 10. Unit: GB

vpcId

Yes

String

VPC ID, which is used for configuring cluster network.

netId

Yes

String

Subnet ID (network ID).

securityGroupId

Yes

String

Security group ID.

ips

No

Array of strings

Node IP address.

key

Yes

String

Tag key. The value can contain 1 to 36 characters. It can only contain digits, letters, hyphens (-), and underscores (_).

value

Yes

String

Tag value. The value can contain 0 to 43 characters. It can only contain digits, letters, hyphens (-), and underscores (_).

version

Yes

String

Version of the CSS cluster engine. For details, see the supported versions in Before You Start.

[For a serverless cluster, logs, search, and vector are supported.] (tag:white)

type

Yes

String

Engine type. Its value can be elasticsearch, opensearch, or logstash.

[For a serverless cluster, serverless-opensearch is used.] (tag:white)

eip

Yes

CreateClusterPublicEip object

Public network bandwidth.

elbWhiteListReq

Yes

CreateClusterElbWhiteList object

EIP whitelist.

publicBindType

Yes

String

Whether to automatically bind an EIP. Specifies whether to automatically bind an EIP. Currently, only auto_assign is supported.

eipId

No

String

EIP ID.

bandWidth

Yes

CreateClusterPublicEipSize object

Public network bandwidth.

size

Yes

Integer

Bandwidth range.

enableWhiteList

Yes

Boolean

Whether to enable the public network access control.

whiteList

No

String

Public network access control whitelist. Separate the whitelisted network segments or IP addresses with commas (,), and each of them must be unique.

endpointWithDnsName

Yes

Boolean

Whether to enable the private domain name.

• true: The private zone is enabled.

• false: The private zone is disabled.

vpcPermissions

No

Array of strings

Access control.

professionVpcep

No

Boolean

Create a professional VPC endpoint.

• true: enabled.

• false: disabled.

dualstackEnable

No

Boolean

Whether to enable the IPv4/IPv6 dual-stack network. The IPv4/IPv6 dual-stack network can be enabled only when a professional VPC endpoint is created and the VPC of the cluster supports IPv6.

• true: enabled.

• false: disabled.

eipSize

Yes

Integer

Bandwidth range.

elbWhiteList

Yes

CreateClusterPublicKibanaElbWhiteList object

Kibana whitelist information.

whiteList

Yes

String

Whitelist. Separate the whitelisted network segments or IP addresses with commas (,), and each of them must be unique.

enableWhiteList

Yes

Boolean

Whether to enable the Kibana access control.

payModel

Yes

Integer

Subscription period type.

• 2: monthly

• 3: yearly

period

Yes

Integer

Subscribed periods.

• If payModel is 2, the value range is 1 to 9.

• If payModel is 3, the value range is 1 to 3.

isAutoRenew

No

Integer

Whether to automatically renew the subscription. If this parameter is not specified, the subscription is not automatically renewed.

• 1: Auto renewal is enabled.

• 0: Auto renewal is disabled (default).

isAutoPay

No

Integer

Indicates whether to enable automatic payment from your Huawei Cloud account. This parameter takes effect only for yearly/monthly clusters.

• 1: Yes. (Discounts and coupons are automatically selected. The fee will be automatically deducted from your Huawei Cloud account.) If the automatic payment fails, an unpaid order will be generated, and you need to manually complete the payment. (During manual payment, you can still modify the discounts and coupons that were automatically selected.)

• 0: No. (The customer needs to manually pay for the bill. Discounts and coupons can be used.) The default value is 0.

systemEncrypted

No

String

Whether to enable disk encryption. The value can be 0 or 1. The default value is 0.

0: Disable disk encryption.

1: Enable disk encryption.

systemCmkid

No

String

KMS key ID. This parameter is valid only when systemEncrypted is set to 1.

cluster

CreateClusterResp object

Cluster object. For a pay-per-use cluster, only the cluster parameter is returned.

orderId

String

Order ID. This parameter is returned only when a yearly/monthly cluster is created.

id

String

Cluster ID.

name

String

Cluster name

200

Request succeeded.

400

Invalid request.

Modify the request before retry.

409

The request could not be completed due to a conflict with the current state of the resource.

The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.

412

The server did not meet one of the preconditions contained in the request.