首页 / API 文档 / 平台管理 / 集群管理 / Machine 管理 / 添加 Machine

添加 Machine

请求信息

请求行

POST /apis/platform.tkestack.io/v1/machines

添加一个 Machine。

请求参数

名称 类型 是否必填项 描述
dryRun string 当该参数出现时,表示不应该持久化修改。一个无效的或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:All,将处理所有的试运行阶段。
fieldManager string fieldManager 是与正在进行这些更改的参与者或实体相关联的名称。值必须少于 128 字符,且仅包含可打印字符,参见 https://golang.org/pkg/unicode/#IsPrint。
pretty string 如果为 true,则会将返回结果输出成适合打印的格式。

请求体

Content-Type */*

请求体示例

在 Kubernetes 集群中的节点实例。

{
   "apiVersion": "platform.tkestack.io/v1",
   "kind": "Machine",
   "metadata": {
     "annotations": {
       "cpaas.io/display-name": "192.168.0.105"
     },
     "name": "mc-192-168-0-105"
   },
   "spec": {
     "clusterName": "global",
     "displayName": "",
     "ip": "192.168.0.105",
     "ipv6": "",
     "networkDevice": "",
     "password": "cGFzc3dvcmQ=",
     "port": 22,
     "proxy": {},
     "publicIP": "",
     "role": "",
     "type": "Baremetal",
     "username": "root"
   }
 }

请求体说明

名称 类型 是否必填项 描述
apiVersion string 查看公共参数
kind string 查看公共参数
metadata object 查看公共参数
spec object 节点的描述信息。
字段路径:spec
spec.clusterName string 集群的名称。
字段路径:spec.clusterName
spec.displayName string 节点的显示名称。
字段路径:spec.displayName
spec.ip string 节点 IP。
字段路径:spec.ip
spec.ipv6 string IPV6 地址。
字段路径:spec.ipv6
spec.networkDevice string 网络设备(网卡)名称。
字段路径:spec.networkDevice
spec.password string (byte) 密码。
字段路径:spec.password
spec.port integer (int32) 端口号。
字段路径:spec.port
spec.proxy object 通过 SSH 服务访问节点的代理。
字段路径:spec.proxy
spec.publicIP string 节点的公网 IP。
字段路径:spec.publicIP
spec.role string 节点的类型,控制节点(master)/计算节点(node)。
字段路径:spec.role
spec.type string 节点的类型。
字段路径:spec.type
spec.username string 用户名。
字段路径:spec.username

返回信息

Content-Type application/json, application/yaml, application/vnd.kubernetes.protobuf

状态码: 201

Created

返回体示例

在 Kubernetes 集群中的节点实例。

{
   "apiVersion": "platform.tkestack.io/v1",
   "kind": "Machine",
   "metadata": {
     "annotations": {
       "cpaas.io/display-name": "192.168.0.105"
     },
     "creationTimestamp": "2021-06-25T02:25:45Z",
     "name": "mc-192-168-0-105",
     "resourceVersion": "100232",
     "selfLink": "/apis/platform.tkestack.io/v1/machines/mc-192-168-0-105",
     "uid": "719f0a5b-a730-41e3-8c15-1572625b3f23"
   },
   "spec": {
     "clusterName": "global",
     "displayName": "",
     "finalizers": [
       "machine"
     ],
     "ip": "192.168.0.105",
     "ipv6": "",
     "networkDevice": "",
     "password": "cGFzc3dvcmQ=",
     "port": 22,
     "proxy": {},
     "publicIP": "",
     "role": "",
     "type": "Baremetal",
     "username": "root"
   },
   "status": {
     "phase": "Initializing"
   }
 }

返回体说明

名称 类型 描述
apiVersion string 查看公共参数
kind string 查看公共参数
metadata object 查看公共参数
spec object 节点的描述信息。
字段路径:spec
spec.clusterName string 集群的名称。
字段路径:spec.clusterName
spec.displayName string 节点的显示名称。
字段路径:spec.displayName
spec.finalizers array 终结器是一个内部的值列表,必须为空才能从存储中永久删除对象。
字段路径:spec.finalizers
spec.finalizers[] string
字段路径:spec.finalizers[]
spec.ip string 节点 IP。
字段路径:spec.ip
spec.ipv6 string IPV6 地址。
字段路径:spec.ipv6
spec.networkDevice string 网络设备(网卡)名称。
字段路径:spec.networkDevice
spec.password string (byte) 密码。
字段路径:spec.password
spec.port integer (int32) 端口号。
字段路径:spec.port
spec.proxy object 通过 SSH 服务访问节点的代理。
字段路径:spec.proxy
spec.publicIP string 节点的公网 IP。
字段路径:spec.publicIP
spec.role string 节点的类型,控制节点(master)/计算节点(node)。
字段路径:spec.role
spec.type string 节点的类型。
字段路径:spec.type
spec.username string 用户名。
字段路径:spec.username
status object MachineStatus 表示关于节点状态的信息。
字段路径:status
status.phase string 节点的执行进度阶段。
字段路径:status.phase

其他状态码

状态码: 200

OK

状态码: 202

Accepted

状态码: 401

Unauthorized