更新时间:2024-12-10 GMT+08:00

集群添加组件

功能介绍

集群添加组件,仅MRS 3.1.2及之后普通版本和MRS 3.1.2-LTS.2及之后的LTS版本的自定义集群支持添加组件功能。

URI

POST /v2/{project_id}/clusters/{cluster_id}/components

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目编号。获取方法,请参见获取项目ID

约束限制:

不涉及

取值范围:

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID。获取方法,请参见获取集群ID

约束限制:

不涉及

取值范围:

只能由英文字母、数字以及“_”和“-”组成,且长度为[1-64]个字符。

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

components_install_mode

Array of ComponentInstallMode objects

参数解释:

组件模型详情,具体参数说明请参考表3

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 ComponentInstallMode

参数

是否必选

参数类型

描述

component

String

参数解释:

组件名称。

约束限制:

不涉及

取值范围:

只能由英文字母、数字以及“_”和“-”组成,且长度为[1-64]个字符。

默认取值:

不涉及

node_groups

Array of AssignedNodeGroup objects

参数解释:

该组件的角色部署信息,具体参数说明请参考表4

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

component_user_password

String

参数解释:

配置组件用户密码,该密码用于ClickHouse组件机机用户连接使用。

约束限制:

不涉及

取值范围:

  • 密码长度应在8~26个字符之间
  • 不能与用户名或者倒序用户名相同
  • 必须包含如下4种字符的组合
  • 至少一个小写字母
  • 至少一个大写字母
  • 至少一个数字
  • 至少一个特殊字符:!@$%^-_=+[{}]:,./?

默认取值:

不涉及

component_default_password

String

参数解释:

配置组件default用户密码,该密码用于ClickHouse组件人机用户连接使用。

约束限制:

不涉及

取值范围:

  • 密码长度应在8~26个字符之间
  • 不能与用户名或者倒序用户名相同
  • 必须包含如下4种字符的组合
  • 至少一个小写字母
  • 至少一个大写字母
  • 至少一个数字
  • 至少一个特殊字符:!@$%^-_=+[{}]:,./?

默认取值:

不涉及

表4 AssignedNodeGroup

参数

是否必选

参数类型

描述

name

String

参数解释:

节点组名称。

约束限制:

不涉及

取值范围:

只能由英文字母、数字以及“_”和“-”组成,且长度为[1-64]个字符。

默认取值:

不涉及

assigned_roles

Array of strings

参数解释:

角色部署信息。 可以指定节点组中部署的角色,该参数是一个字符串数组,每个字符串表示一个角色表达式。 角色表达式定义:

  • 当该角色在节点组所有节点部署时: {role name},如“DataNode”。
  • 当该角色在节点组指定下标节点部署时:{role name}:{index1},{index2}…,{indexN},如“NameNode:1,2”,下标从1开始计数。
  • 可选的角色请参考MRS支持的角色与组件对应表

约束限制:

不能超过1000条。

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

result

String

参数解释:

更新映射请求操作结果。

约束限制:

不涉及

取值范围:

  • succeeded:操作成功
  • failed:操作失败

默认取值:

不涉及

请求示例

  • 非安全集群添加请求添加ClickHouse组件:
    v2/f77c10d14a544393a24e5f0bf53202b6/clusters/ff879d3a-e5d5-4485-a9b6-c673b52673fa/components
    
    {
      "components_install_mode" : [ {
        "component" : "ClickHouse",
        "node_groups" : [ {
          "name" : "master_node_default_group",
          "assigned_roles" : [ "ClickHouseServer:1,2" ]
        }, {
          "name" : "node_group_1",
          "assigned_roles" : [ "ClickHouseServer", "ClickHouseBalancer" ]
        } ],
        "component_user_password" : "*****",
        "component_default_password" : "*****"
      } ]
    }
  • 添加HBase组件:
    v2/f77c10d14a544393a24e5f0bf53202b6/clusters/ff879d3a-e5d5-4485-a9b6-c673b52673fa/components
    
    {
      "components_install_mode" : [ {
        "component" : "HBase",
        "node_groups" : [ {
          "name" : "master_node_default_group",
          "assigned_roles" : [ "RegionServer", "HMaster" ]
        } ]
      } ]
    }

响应示例

状态码: 200

请求处理结果:

{
  "result" : "succeeded"
}

状态码

状态码请参见状态码

错误码

请参见错误码