创建集群（已废弃）

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID和名称。

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及

cluster

是

CreateClusterBody object

参数解释：

集群对象。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

instance

是

CreateClusterInstanceBody object

参数解释：

实例对象。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

datastore

是

CreateClusterDatastoreBody object

参数解释：

数据搜索引擎类型。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

是

String

参数解释：

集群名称。

约束限制：

不涉及

取值范围：

4～32个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。

默认取值：

不涉及

desc

否

String

参数解释：

集群描述。

约束限制：

不涉及

取值范围：

不超过128个字符。

默认取值：

不涉及

instanceNum

是

Integer

参数解释：

集群实例个数。

约束限制：

不涉及

取值范围：

1~32。

默认取值：

不涉及

backupStrategy

否

CreateClusterBackupStrategyBody object

参数解释：

开启自动创建快照策略，默认关闭。

当backupStrategy参数配置不为空时，才会开启自动创建快照策略。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

httpsEnable

否

Boolean

参数解释：

设置是否进行通信加密。取值范围为true或false。默认关闭通信加密功能。当httpsEnable设置为true时，authorityEnable字段需要设置为true。

约束限制：

Elasticsearch安全集群只有6.5.4及之后版本支持。

OpenSearch安全集群只有1.3.6和2.19.0版本支持关闭HTTPS访问，其他版本均强制启用HTTPS访问，不可关闭。

取值范围：

• true：表示集群进行通信加密。

• false：表示集群不进行通信加密。

默认取值：

false

authorityEnable

否

Boolean

参数解释：

是否开启认证，取值范围为true或false。默认关闭认证功能。

约束限制：

Elasticsearch安全集群只有6.5.4及之后版本支持。

取值范围：

• true：表示集群开启认证。

• false：表示集群不开启认证。

默认取值：

false

adminPwd

否

String

参数解释：

安全模式下集群管理员admin的密码，只有在创建集群时authorityEnable设置为true时需要设置此参数。安全集群的密码会进行弱口令校验，建议设置安全性高的密码。

约束限制：

管理员密码需要满足规则：

• 可输入的字符串长度为8-32个字符。

• 密码至少包含大写字母，小写字母，数字和特殊字符中的三类，其中可输入的特殊字符为：~!@#$%^&*()-_=+\|[{}];:,<.>/?。

取值范围：

参考约束限制

默认取值：

不涉及

enterprise_project_id

否

String

参数解释：

企业项目ID。创建集群时，给集群绑定企业项目ID。最大长度36个字符，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tags

否

Array of CreateClusterTagsBody objects

参数解释：

集群标签。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

ipv6_enable

否

Boolean

参数解释：

集群是否开启自动分配IPv6地址，默认值为false。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

false

diskEncryption

否

diskEncryptionInfo object

参数解释：

磁盘加密信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

flavorRef

是

String

参数解释：

实例规格名称。可以使用获取实例规格列表的name属性确认当前拥有的规格信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

volume

是

CreateClusterInstanceVolumeBody object

参数解释：

volume信息。当flavorRef选择的是本地盘规格时不需要填写，目前支持的本地盘规格有：

• 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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

nics

是

CreateClusterInstanceNicsBody object

参数解释：

子网信息。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

availability_zone

是

String

参数解释：

节点所在的可用区，需要指定可用区的名称（可用分区名称）。

约束限制：

指定节点所在的可用区时，各个可用区名称需要使用英文逗号（,）分隔，以“通用可用区”为例，选择多可用区时，availability_zone取值为region-1a,region-1b,region-1c。

取值范围：

不涉及

默认取值：

availability_zone默认为空，表示使用单个可用分区。

volume_type

是

String

参数解释：

卷类型。

约束限制：

不涉及

取值范围：

• COMMON：普通I/O。

• HIGH：高I/O。

• ULTRAHIGH：超高I/O。

• ESSD：极速SSD。

默认取值：

不涉及

size

是

Integer

参数解释：

磁盘大小。

约束限制：

必须为大于0且为4和10的公倍数，单位：GB。

取值范围：

磁盘规格大小可以通过获取实例规格列表中diskrange属性获得。

默认取值：

• ess节点和ess-cold节点：默认100G与节点规格支持的最小磁盘容量取较大者。

• ess-master节点和ess-client节点：默认大小为40G，且不可更改。

vpcId

是

String

参数解释：

指定虚拟私有云ID，用于集群网络配置。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

netId

是

String

参数解释：

子网ID(网络ID)。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

securityGroupId

是

String

参数解释：

安全组ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

version

是

String

参数解释：

Elasticsearch/Logstash引擎版本号。详细请参考CSS使用前必读中支持的版本。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

type

是

String

参数解释：

要创建的集群的引擎类型。

约束限制：

不涉及

取值范围：

• elasticsearch：Elasticsearch集群。

• opensearch：OpenSearch集群。

• logstash：Logstash集群。

- serverless-opensearch：Serverless集群。

默认取值：

不涉及

period

否

String

参数解释：

每天创建快照的时刻。

约束限制：

不涉及

取值范围：

只支持整点，后面需加上时区，格式为HH:mm z，HH:mm表示整点时间，z表示时区。 比如00:00 GMT+08:00、01:00 GMT+08:00等。

默认取值：

00:00 GMT+08:00

prefix

是

String

参数解释：

自动创建的快照的前缀，需要用户自己手动输入。

约束限制：

不涉及

取值范围：

只能包含1~32位小写字母、数字、中划线或者下划线，并且以小写字母开头。

默认取值：

不涉及

keepday

是

Integer

参数解释：

自定义设置快照保留的个数，系统在半点时刻会自动删除超过保留个数的快照。过期删除策略只针对与当前自动创建快照策略相同执行频次的自动快照。

约束限制：

不涉及

取值范围：

1～90

默认取值：

不涉及

bucket

否

String

参数解释：

备份使用的OBS桶名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

basePath

否

String

参数解释：

快照在OBS桶中的存放路径。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

agency

否

String

参数解释：

委托名称，委托给CSS，允许CSS调用您的其他云服务。无法配置含特殊字符和中文字符的委托。

约束限制：

不涉及

取值范围：

允许使用的委托名称仅可包含a-zA-Z0-9-_字符。

默认取值：

不涉及

frequency

否

String

参数解释：

自动创建快照的执行频次。

约束限制：

不涉及

取值范围：

• HOUR：表示每小时整点执行一次。

• DAY：表示每天执行一次。

• SUN、MON、TUE、WED、THU、FRI、SAT：表示在每周对应时间执行一次。比如SUN表示每周日执行一次。

• 保留快照个数与自动创建快照策略中设置的执行频次和索引有关。当执行频次间隔时间短或索引数据量大，保留自动快照可能会达不到设置的个数，请谨慎选择！

默认取值：

DAY

maxSnapshotBytesPerSeconds

否

String

参数解释：

配置每个节点的最大备份速率（每秒），即当备份的速率超过该值时会被限流，避免速率太大导致资源占用过高，影响系统稳定性。实际备份速率不一定能达到该值，会受OBS、磁盘等影响。

约束限制：

不涉及

取值范围：

有以下3种填写规则：

• 数字+单位

• 0

• -1

数字部分支持0~9999。

单位部分支持k、kb、m、mb、g、gb、t、tb、p、pb、b，且不区分大小写。

当填写0mb、0或-1时，表示不限速，当备份速率过大时，可能导致备份占用资源过高，影响系统稳定性。

默认取值：

默认值是40MB，不填写时表示使用默认值。

maxRestoreBytesPerSeconds

否

String

参数解释：

配置每个节点的最大恢复速率（每秒），即当恢复的速率超过该值时会被限流，避免速率太大导致资源占用过高，影响系统稳定性。实际恢复速率不一定能达到该值，会受OBS、磁盘等影响。

约束限制：

OpenSearch集群和版本高于7.6.2的Elasticsearch集群，恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数。当“最大恢复速率（每秒）”小于“indices.recovery.max_bytes_per_sec”的参数值时，恢复速率达到“最大恢复速率（每秒）”参数值时就会被限流。当“最大恢复速率（每秒）”大于“indices.recovery.max_bytes_per_sec”的参数值时，恢复速率达到“indices.recovery.max_bytes_per_sec”参数值时就会被限流。

取值范围：

有以下3种填写规则：

• 数字+单位

• 0

• -1

数字部分支持0~9999。

单位部分支持k、kb、m、mb、g、gb、t、tb、p、pb、b，且不区分大小写。

当填写0mb、0或-1时，表示不限速（但OpenSearch集群和版本高于7.6.2的Elasticsearch集群，恢复速率还受限于“indices.recovery.max_bytes_per_sec”参数），当恢复速率过大时，可能导致恢复占用资源过高，影响系统稳定性。

默认取值：

7.6.2及以下版本的Elasticsearch集群，默认值是40MB。

OpenSearch集群和7.6.2以上版本的Elasticsearch集群，默认值是不限制，但还受限于“indices.recovery.max_bytes_per_sec”参数。

不填写时表示使用默认值。

key

是

String

参数解释：

集群标签的key值。

约束限制：

不涉及

取值范围：

可输入的字符串长度为1~36个字符。只能包含数字、字母、中划线"-"和下划线"_"。

默认取值：

不涉及

value

是

String

参数解释：

集群标签的value值。

约束限制：

不涉及

取值范围：

• 长度0~255个字符

• 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _.://=+-@

默认取值：

不涉及

systemEncrypted

否

String

是否开启磁盘加密，可选值：0和1，默认为0。

0：不开启磁盘加密

1：开启磁盘加密

systemCmkid

否

String

KMS密钥ID，systemEncrypted为1时有效。

cluster

CreateClusterClusterResponse object

参数解释：

集群对象。若创建的是按需集群，则只返回cluster参数。

取值范围：

不涉及

id

String

参数解释：

集群ID。

取值范围：

不涉及

name

String

参数解释：

集群名称。

取值范围：

不涉及

200

请求成功。

400

非法请求。

建议直接修改该请求，不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。