Creating a Cluster (Discarded)

Function

This API can only be used to create clusters that contain a single type of nodes. To create clusters that contain multiple types of nodes (ess, ess-cold, ess-client, and ess-master), use the API for Creating a Cluster v2.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
cluster	Yes	CreateClusterBody object	Parameter description: Cluster object. Constraints: N/A Options: N/A Default value: N/A

**Table 3** CreateClusterBody
Parameter	Mandatory	Type	Description
instance	Yes	CreateClusterInstanceBody object	Parameter description: Array of Buffer instances, whose memory is to be shared. Constraints: N/A Options: N/A Default value: N/A
datastore	Yes	CreateClusterDatastoreBody object	Definition: Search engine. Constraints: N/A Value range: N/A Default value: N/A
name	Yes	String	Definition: Cluster name. Constraints: N/A Value range: It can contain 4 to 32 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. Default value: N/A
desc	No	String	Definition: Cluster description. Constraints: Enter a maximum of 128 characters. Value range: The value can contain digits, letters, periods (.), hyphens (-), underscores (_), and other special characters. Default value: N/A
instanceNum	Yes	Integer	Definition: Number of cluster instances. Constraints: N/A Value range: 1–32. Default value: N/A
backupStrategy	No	CreateClusterBackupStrategyBody object	Parameter description: Automatic snapshot creation policy, which is disabled by default. The automatic snapshot creation policy is enabled only when backupStrategy is not left blank. Constraints: N/A Options: N/A Default value: N/A
httpsEnable	No	Boolean	Definition: 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. Constraints: Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter. HTTPS access can be disabled only for OpenSearch 1.3.6 and 2.19.0 security-mode clusters. For other versions, HTTPS access is forcibly enabled and cannot be disabled. Value range: true: Communication is encrypted on the cluster. false: Communication is not encrypted for the cluster. Default value: false
authorityEnable	No	Boolean	Definition: Whether to enable authentication. Available values include true and false. Authentication is disabled by default. Constraints: Only Elasticsearch 6.5.4 security-mode clusters and later support this parameter. Value range: true: Authentication is enabled for the cluster. false: Authentication is disabled for the cluster. Default value: false
adminPwd	No	String	Parameter description: Password of the cluster user admin in security mode. This parameter is mandatory only when authorityEnable is set to true. Weak password verification is required for a security cluster. You are advised to set a strong password. Constraints: The administrator password must meet the following requirements: The password can contain 8 to 32 characters. Passwords must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters ~!@#$%^&()-_=+\\|[{}];:,<.>/? Options: See Constraints. Default value*: N/A
enterprise_project_id	No	String	Parameter description: 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. Constraints: N/A Options: N/A Default value: N/A
tags	No	Array of CreateClusterTagsBody objects	Parameter description: Cluster tags. Constraints: N/A Options: N/A Default value: N/A
ipv6_enable	No	Boolean	Definition: Whether to enable automatic IPv6 address assignment for the cluster. The default value is false. Constraints: N/A Value range: N/A Default value: false

**Table 4** CreateClusterInstanceBody
Parameter	Mandatory	Type	Description
flavorRef	Yes	String	Parameter description: Instance flavor name. For details about the current instance flavor, see the name attribute in Obtaining the Instance Specifications List. Constraints: N/A Options: N/A Default value: N/A
volume	Yes	CreateClusterInstanceVolumeBody object	Parameter description: Volume information. You do not need to set this parameter when flavorRef is set to a local disk flavor. 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 Constraints: N/A Options: N/A Default value: N/A
nics	Yes	CreateClusterInstanceNicsBody object	Parameter description: Subnet information. Constraints: N/A Options: N/A Default value: N/A
availability_zone	Yes	String	Definition: AZ of the node. The AZ name needs to be specified. Constraints: When specifying the AZs of nodes, use commas (,) to separate different AZ names. For example, if multiple AZs are selected for general AZs, the value of availability_zone is region-1a,region-1b,region-1c. Value range: N/A Default value: availability_zone is empty by default, indicating that a single AZ is used. 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 evenly divisible by the number of AZs, the nodes will be evenly distributed among all AZs. If the number of nodes is not evenly divisible by the number of AZs, the absolute difference between node quantity in any two AZs is 1 at most. AZ name. Obtain it from Regions and Endpoints in section "Before You Start".

**Table 5** CreateClusterInstanceVolumeBody
Parameter	Mandatory	Type	Description
volume_type	Yes	String	Parameter description: Volume type. Constraints: N/A Options: COMMON: common I/O HIGH: high I/O ULTRAHIGH: ultra-high I/O ESSD: ultra-fast SSD Default value: N/A
size	Yes	Integer	Definition: Disk size. Constraints: The value must be greater than 0 and a common multiple of 4 and 10, in GB. Value range: You can obtain the disk size from the diskrange attribute in Obtaining the Instance Specifications List. Default value: ess and ess-cold nodes: 100 GB or the minimum disk capacity supported by the selected node flavor, whichever is larger. ess-master and ess-client nodes: The default volume size is 40 GB and cannot be changed. NOTE: For ess and ess-cold nodes, 100 GB or a larger value is recommended.

**Table 6** CreateClusterInstanceNicsBody
Parameter	Mandatory	Type	Description
vpcId	Yes	String	Parameter description: VPC ID, which is used for configuring cluster network. Constraints: N/A Options: N/A Default value: N/A
netId	Yes	String	Parameter description: Subnet ID (network ID). Constraints: N/A Options: N/A Default value: N/A
securityGroupId	Yes	String	Parameter description: Security group ID Constraints: N/A Options: N/A Default value: N/A

**Table 7** CreateClusterDatastoreBody
Parameter	Mandatory	Type	Description
version	Yes	String	Parameter description: Elasticsearch/Logstash engine version. For details, see the supported versions in Before You Start. Constraints: N/A Options: N/A Default value: N/A
type	Yes	String	Definition: Engine type of the cluster to be created. Constraints: N/A Value range: elasticsearch: Elasticsearch cluster. opensearch: OpenSearch cluster. logstash: Logstash cluster. Default value: N/A

**Table 8** CreateClusterBackupStrategyBody
Parameter	Mandatory	Type	Description
period	Yes	String	Definition: Time when a snapshot is generated every day. Constraints: N/A Value range: Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, HH:mm z. In the format, 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. Default value: 00:00 GMT+08:00 NOTE: 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.
prefix	Yes	String	Definition: Prefix of a snapshot that is automatically created, which is manually entered. Constraints: N/A Value range: Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed. Default value: N/A
keepday	Yes	Integer	Definition: Set the number of snapshots to be retained. 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. Constraints: N/A Value range: 1–90 Default value: N/A
bucket	No	String	Parameter description: Name of the OBS bucket used for backup. Constraints: N/A Options: N/A Default value: N/A
basePath	No	String	Parameter description: Storage path of the snapshot in the OBS bucket. Constraints: N/A Options: N/A Default value: N/A
agency	No	String	Definition: Agency name. You can create an agency to allow CSS to call other cloud services. An agency name cannot contain special characters or Chinese characters. Constraints: N/A Value range: Only a-z, A-Z, 0-9, hyphens (-) and underscores (_) are allowed. Default value: N/A NOTE: If none of the bucket, basePath, 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.
frequency	No	String	Definition: Frequency of automatically creating snapshots. Constraints: N/A Value range: HOUR: Execute once every hour on the hour. DAY: Execute once every day. SUN, MON, TUE, WED, THU, FRI, and SAT: Execute the task 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. Default value: DAY
maxSnapshotBytesPerSeconds	No	String	Definition: This parameter sets the maximum backup speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual backup speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O. Constraints: N/A Value range: The following values and formats are allowed: 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 (case-insensitive). 0mb means there is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully. 0 There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully. -1 There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully. Default value: The default value is 40 MB. If this parameter is left blank, the default value is used.
maxRestoreBytesPerSeconds	No	String	Definition: This parameter sets the maximum recovery speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O. Constraints: For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter. If Maximum recovery speed (per second) is lower than indices.recovery.max_bytes_per_sec, flow control is triggered when the former is reached. If Maximum recovery speed (per second) is higher than indices.recovery.max_bytes_per_sec, flow control is triggered when the latter is reached. Value range: The following values and formats are allowed: 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 (case-insensitive). 0mb means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully. 0 There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully. -1 There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully. Default value: For Elasticsearch clusters of 7.6.2 or earlier, the default setting is 40mb. For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the default setting is no limit, but the recovery speed is still limited by the indices.recovery.max_bytes_per_sec parameter. If this parameter is left blank, the default setting is used.

**Table 9** CreateClusterTagsBody
Parameter	Mandatory	Type	Description
key	Yes	String	Definition: Tag key. Constraints: N/A Value range: The value can contain 1 to 36 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. Default value: N/A
value	Yes	String	Definition: Tag value. Constraints: N/A Value range: Length: 0 to 255 characters. The value can contain UTF-8 letters, digits, spaces, and special characters _.://=+-@ Default value: N/A

Response Parameters

Status code: 200

**Table 10** Response body parameters
Parameter	Type	Description
cluster	CreateClusterClusterResponse object	Parameter description: Cluster object. For a pay-per-use cluster, only the cluster parameter is returned. Options: N/A

**Table 11** CreateClusterClusterResponse
Parameter	Type	Description
id	String	Parameter description: Cluster ID. Options: N/A
name	String	Parameter description: Cluster name. Options: N/A

Example Requests

Example request for creating a pay-per-use cluster.

POST https://{Endpoint}/v1.0/{project_id}/clusters

{
  "cluster" : {
    "instance" : {
      "flavorRef" : "ess.spec-4u16g",
      "volume" : {
        "volume_type" : "COMMON",
        "size" : 120
      },
      "nics" : {
        "vpcId" : "{VPC ID}",
        "netId" : "{NET ID}",
        "securityGroupId" : "{Security group ID}"
      },
      "availability_zone" : "{AZ CODE}"
    },
    "datastore" : {
      "version" : "{cluster-version}",
      "type" : "elasticsearch"
    },
    "name" : "cluster-name",
    "desc" : "Cluster testing",
    "instanceNum" : 3,
    "backupStrategy" : {
      "period" : "16:00 GMT+08:00",
      "prefix" : "snapshot",
      "keepday" : 7,
      "frequency" : "DAY",
      "bucket" : "css-obs-backup",
      "basePath" : "css_repository/obs-path",
      "agency" : "css_obs_agency",
      "maxSnapshotBytesPerSeconds" : 40,
      "maxRestoreBytesPerSeconds" : 40
    },
    "httpsEnable" : true,
    "authorityEnable" : true,
    "adminPwd" : "{password}",
    "enterprise_project_id" : "0",
    "tags" : [ {
      "key" : "k1",
      "value" : "v1"
    }, {
      "key" : "k2",
      "value" : "v2"
    } ]
  }
}

Example Responses

Status code: 200

Request succeeded.

Example response for creating a pay-per-use cluster.

{
  "cluster" : {
    "id" : "ef683016-871e-48bc-bf93-74a29d60d214",
    "name" : "ES-Test"
  }
}

Status Codes

Status Code	Description
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.