纳管手动发放的集群 - EnrollCluster
功能介绍
纳管手动发放的集群。该接口只适用于25.12.0版本之前的集群进行调用,25.12.0版本及之后版本的集群,无需调用该接口。
URI
POST /v1/clusters/enroll
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cluster_id | 否 | String | 参数解释 集群ID,资源唯一标识。该值为空时,系统自动生成集群id;不为空时,使用该值作为集群id。 约束限制 不涉及。 取值范围 必须为UUID格式。 默认取值 不涉及。 |
| name | 是 | String | 参数解释 集群名称。 约束限制 不涉及。 取值范围 以小写字母开头,由字母、数字、中划线(-)组成,长度范围4-128位,且不能以中划线(-)结尾。 默认取值 不涉及。 |
| description | 否 | String | 参数解释 集群描述。 约束限制 不涉及。 取值范围 由字母、数字、中划线(-)组成,长度范围不超过256字节,且不能以中划线(-)结尾。 默认取值 不涉及。 |
| k8s_cluster_specification | 是 | 参数解释 业务k8s集群部署配置。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 | |
| vpc_endpoint_id | 否 | String | 参数解释 VPC终端节点的ID,唯一标识。 约束限制 不涉及。 取值范围 必须为UUID格式。 默认取值 不涉及。 |
| vpc_security_group_ids | 否 | Array of strings | 参数解释 已配置的安全组id列表。在VPC服务安全组下,根据EMS实例id对应的安全组。 约束限制 不涉及。 取值范围 安全组ID列表,每个安全组ID必须为UUID格式。 默认取值 不涉及。 |
| lts_host_group | 否 | String | 参数解释 LTS主机组。在LTS服务主机管理,根据EMS集群ID关联的主机组。 约束限制 不涉及。 取值范围 必须为UUID格式。 默认取值 不涉及。 |
| lts_group | 否 | String | 参数解释 LTS日志组。在LTS服务日志管理,根据EMS集群ID关联的日志组。 约束限制 不涉及。 取值范围 必须为UUID格式。 默认取值 不涉及。 |
| lts_streams | 否 | Array of strings | 参数解释 LTS日志流列表。在LTS服务日志管理,根据EMS集群ID关联的日志组,归属于对应日志组的日志流ID列表。 约束限制 不涉及。 取值范围 日志流ID列表,每个日志流ID必须为UUID格式。 默认取值 不涉及。 |
| lts_access_configs | 否 | Array of strings | 参数解释 LTS日志接入列表。在LTS服务日志接入,根据EMS集群ID关联的日志组,接入的配置ID列表。 约束限制 不涉及。 取值范围 日志接入配置ID列表,每个配置ID为字符串。 默认取值 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| k8s_cluster_id | 是 | String | 参数解释 CCE集群ID。 约束限制 不涉及。 取值范围 必须为UUID格式。 默认取值 不涉及。 |
| namespace | 是 | String | 参数解释 CCE集群中部署ems服务的命名空间。 约束限制 不涉及。 取值范围 由字母或数字开始,后面可以跟随零个或多个由字母、数字或连字符组成的字符串,并且以小写字母或数字结束的字符串组成。且长度范围1-64个字符。 默认取值 不涉及。 |
| label | 否 | K8sLabel object | 参数解释 指定CCE集群中的安装范围,当前支持指定标签。Map对象,key为标签名,value为标签值。 约束限制 不涉及。 取值范围 不涉及。 默认取值 不涉及。 |
| flavor | 否 | String | 参数解释 集群实例规格。 约束限制 不涉及。 取值范围 由一个或多个字母开始,后面跟随一个或多个由点分隔的字母段的字符串组成。且长度范围1-64个字符。 默认取值 不涉及。 |
| version | 否 | String | 参数解释 集群版本,发放的集群版本。 约束限制 不涉及。 取值范围 不涉及。 默认取值 v1。 |
| lts_enable | 否 | Boolean | 参数解释 是否安装云原生日志采集插件用LTS采集日志,安装前请提前创建LTS的转储委托。 约束限制 不涉及。 取值范围 默认取值 true。 |
| lts_connect_type | 否 | Integer | 参数解释 日志接入方式。 约束限制 不涉及。 取值范围 默认取值 0。 |
| monitor_enable | 否 | Boolean | 参数解释 是否安装云原生监控插件。 约束限制 不涉及。 取值范围 默认取值 true。 |
响应参数
状态码:202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 参数解释 任务ID,可以通过任务查询接口查询任务执行详情。 取值范围 必须为UUID格式。 |
| cluster_id | String | 参数解释 本次创建的集群ID。 取值范围 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释 错误码,用于标识具体的错误类型。 取值范围 不涉及。 |
| error_msg | String | 参数解释 错误描述,用于说明具体的错误信息。 取值范围 不涉及。 |
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 202 | 参数解释 纳管手动发放的集群成功返回响应体。 取值范围 不涉及。 |
| 400 | 参数解释 错误响应体。 取值范围 不涉及。 |
错误码
请参见错误码。