平台中心
首页 / API 文档 / 平台管理 / 集群管理 / Machine 管理 / 删除指定 Machine

删除指定 Machine

请求信息

请求行

DELETE /apis/platform.tkestack.io/v1/machines/{name}

删除一个 Machine。

请求行参数

名称 类型 是否必填项 描述
name string 是Machine 的名称。

请求参数

名称 类型 是否必填项 描述
dryRun string 否当该参数出现时，表示不应该持久化修改。一个无效的或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：All，将处理所有的试运行阶段。
gracePeriodSeconds integer 否对象被删除之前的宽限期，单位：秒。值必须是非负整数。值 0 表示立即删除。如果该值为 nil，则将使用指定类型的默认宽限期。
orphanDependents boolean 否已弃用：请使用 PropagationPolicy，此字段将在 1.7 中弃用。 是否应该孤立依赖对象。 如果为 true / false，则将 “orphan” 终结器添加到对象的终结器列表中/从该列表中删除。 可以设置此字段或 PropagationPolicy，但不能同时设置。
propagationPolicy string 否是否以及如何执行垃圾回收。 可以设置此字段或 OrphanDependents，但不能两者都设置。 默认策略由 meta.finalizers 中设置的现有终结器和特定于资源的默认策略决定。 可接受的值为：Orphan，孤立； Background，允许垃圾收集器在后台删除依赖项； Foreground，一种级联策略，删除前台中的所有依赖项。
pretty string 否如果为 true，则会将返回结果输出成适合打印的格式。

请求体

Content-Type */*

请求体示例

当删除一个 API 对象时，DeleteOptions 可能被提供。

{
   "apiVersion": "",
   "dryRun": [
     ""
   ],
   "gracePeriodSeconds": 1,
   "kind": "",
   "orphanDependents": false,
   "preconditions": {
     "resourceVersion": "",
     "uid": ""
   },
   "propagationPolicy": ""
 }

请求体说明

名称 类型 是否必填项 描述
apiVersion string 否查看公共参数
dryRun array 否 试运行模式。设置该参数表示修改不会写入存储。一个无效的或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。 有效值为 All，表示将运行所有的试运行阶段。
字段路径：dryRun
dryRun[] string 否
字段路径：dryRun[]
gracePeriodSeconds integer (int64) 否 表示对象被删除之前的持续时间（以秒为单位）。 值必须是非负整数。零值表示立即删除。如果此值为 nil，则将使用指定类型的默认宽限期。如果未指定，则为每个对象的默认值。
字段路径：gracePeriodSeconds
kind string 否查看公共参数
orphanDependents boolean 否 已弃用：该字段将在 1.7 中弃用，请使用 propagationPolicy 字段。 该字段表示依赖对象是否为孤儿对象（Orphan）。如果为 true/false，对象的 finalizers 列表中会被添加上或者移除掉 “orphan” 终结器（Finalizer）。 可以设置此字段或者设置 propagationPolicy 字段，但不能同时设置以上两个字段。
字段路径：orphanDependents
preconditions object 否 执行操作（更新、删除等）之前必须满足前提条件。
字段路径：preconditions
preconditions.resourceVersion string 否 指定目标资源版本。
字段路径：preconditions.resourceVersion
preconditions.uid string 否 指定目标 UID。
字段路径：preconditions.uid
propagationPolicy string 否 表示是否以及如何执行垃圾收集。可以设置此字段或 orphanDependents 字段，但不能同时设置二者。 默认策略由 metadata.finalizers 中现有终结器（Finalizer）集合和特定资源的默认策略决定。 可接受的值为： Orphan - 令依赖对象成为孤儿对象；Background -允许垃圾收集器在后台删除依赖项；Foreground - 一个级联策略，前台删除所有依赖项。
字段路径：propagationPolicy

返回信息

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

状态码: 200

OK

返回体示例

在 Kubernetes 集群中的节点实例。

{
   "apiVersion": "platform.tkestack.io/v1",
   "kind": "Machine",
   "metadata": {
     "annotations": {
       "cpaas.io/display-name": "192.168.0.104"
     },
     "creationTimestamp": "2021-06-24T02:25:45Z",
     "name": "mc-192-168-0-104",
     "resourceVersion": "2078561",
     "selfLink": "/apis/platform.tkestack.io/v1/machines/mc-192-168-0-104",
     "uid": "719f0a5b-a730-41e3-8c15-1572675b6423"
   },
   "spec": {
     "clusterName": "global",
     "displayName": "",
     "finalizers": [
       "machine"
     ],
     "ip": "192.168.0.104",
     "ipv6": "",
     "networkDevice": "",
     "port": 22,
     "proxy": {},
     "publicIP": "",
     "role": "",
     "type": "Baremetal",
     "username": "root"
   },
   "status": {
     "conditions": [
       {
         "lastProbeTime": "2021-07-01T09:14:06Z",
         "lastTransitionTime": "2021-06-24T02:26:34Z",
         "status": "True",
         "type": "HealthCheck"
       }
     ],
     "machineInfo": {},
     "phase": "Terminating"
   }
 }

返回体说明

名称 类型 描述
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.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.conditions array 节点的执行进度。
字段路径：status.conditions
status.conditions[] object MachineCondition 包含了该节点当前条件的详细信息。
字段路径：status.conditions[]
conditions[].lastProbeTime string (date-time) Time 是时间的包装。Time 支持正确的封送到 YAML 和 JSON。时间包提供方的许多工厂方法都提供了包装器。
字段路径：status.conditions[].lastProbeTime
conditions[].lastTransitionTime string (date-time) Time 是时间的包装。Time 支持正确的封送到 YAML 和 JSON。时间包提供方的许多工厂方法都提供了包装器。
字段路径：status.conditions[].lastTransitionTime
conditions[].status string 条件的状态，可以是 True、False、Unknown。
字段路径：status.conditions[].status
conditions[].type string 条件的类型。
字段路径：status.conditions[].type
status.machineInfo object MachineSystemInfo 是唯一标识节点的一组 id 或 uuid。
字段路径：status.machineInfo
status.phase string 节点的执行进度阶段。
字段路径：status.phase

其他状态码

状态码: 202

Accepted

状态码: 401

Unauthorized