首页 / API 文档 / 项目管理 / 项目基础操作 / 删除指定项目

删除指定项目

请求信息

请求行

DELETE /apis/auth.alauda.io/v1/projects/{name}

删除一个项目。

请求行参数

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

请求参数

名称 类型 是否必填项 描述
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 application/json, application/yaml

请求体示例

当删除一个 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

状态码: 200

OK

返回体示例

Status 是不返回其他对象的请求的返回值。

{
   "apiVersion": "",
   "code": 1,
   "details": {
     "causes": [
       {
         "field": "",
         "message": "",
         "reason": ""
       }
     ],
     "group": "",
     "kind": "",
     "name": "",
     "retryAfterSeconds": 1,
     "uid": ""
   },
   "kind": "",
   "message": "",
   "metadata": {
     "continue": "",
     "remainingItemCount": 1,
     "resourceVersion": "",
     "selfLink": ""
   },
   "reason": "",
   "status": ""
 }

返回体说明

名称 类型 描述
apiVersion string 查看公共参数
code integer (int32) 此状态的 HTTP 返回码(建议值),如果不设置,将为 0 。
字段路径:code
details object StatusDetails 是一组附加属性,可以由服务器设置以提供有关响应的附加信息。 状态对象的 Reason 字段定义了将设置哪些属性。 客户端必须忽略与每个属性的定义类型不匹配的字段,并且应该假定任何属性可能为空、无效或未定义。
字段路径:details
details.causes array Causes 数组包含与 StatusReason 故障相关的更多详细信息。 并非所有 StatusReasons 都可以提供详细的原因。
字段路径:details.causes
details.causes[] object StatusCause 提供有关 api.Status 故障的更多信息,包括遇到多个错误的情况。
字段路径:details.causes[]
causes[].field string 导致此错误的资源的字段,由其 JSON 序列化命名。可以包含用于嵌套属性的点和后缀符号。数组是 0。字段可能在原因数组中出现多次,因为字段有多个错误。可选。
字段路径:details.causes[].field
causes[].message string 对错误原因的可读描述。 该字段可按原样呈现给读者。
字段路径:details.causes[].message
causes[].reason string 机器可读的错误根因描述。如果为空,说明没有可获取的信息。
字段路径:details.causes[].reason
details.group string 与状态 StatusReason 关联的资源的组属性。
字段路径:details.group
details.kind string 与状态 StatusReason 关联的资源的 kind 属性。某些操作可能与请求的资源类型不同。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
字段路径:details.kind
details.name string 与状态 StatusReason 关联的资源的名称属性(当只有一个名称可以描述时)。
字段路径:details.name
details.retryAfterSeconds integer (int32) 如果指定,为应重试操作前的秒数时间。某些错误可能表明客户端必须采取替代操作——对于这些错误,此字段可能指示在采取替代操作之前需要等待多长时间。
字段路径:details.retryAfterSeconds
details.uid string 资源的 UID。更多信息:http://kubernetes.io/docs/user-guide/identifiers#uids
字段路径:details.uid
kind string 查看公共参数
message string 该操作状态的可读描述。
字段路径:message
metadata object 查看公共参数
reason string 关于此操作为何处于 Failure (失败)状态的机器可读描述。 如果该值为空,表示没有可用信息。 Reason 澄清了 HTTP 状态代码,但不会覆盖它。
字段路径:reason
status string 操作的状态,取值为 “Success” 或 “Failure”。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
字段路径:status

其他状态码

状态码: 202

Accepted

状态码: 401

Unauthorized