文档首页 > > API参考> Kubernetes API> StatefulSet>

删除指定的StatefulSet

删除指定的StatefulSet

分享
更新时间:2021/04/14 GMT+08:00

功能介绍

This API is used to delete a StatefulSet resource object.

URI

DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} (适用于1.9及以上版本的所有集群)

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name} (仅适用于1.15及以下版本的集群)

表1描述该API的参数。

表1 参数解释

参数

是否必选

描述

name

Yes

Name of the StatefulSet.

namespace

Yes

Object name and auth scope, such as for teams and projects.

pretty

No

If 'true', then the output is pretty printed.

gracePeriodSeconds

No

The duration in seconds before the object should be deleted. Value must be a non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

No

Deprecated: Use the PropagationPolicy. This field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

No

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

请求消息

请求参数:

请求参数的详细描述请参见表2

请求示例:

  • 只删除StatefulSet(对应Pod不删除)
    {
        "Kind": "DeleteOptions",
        "apiVersion": "v1",
        "propagationPolicy": "Orphan"
    }
  • 前台级联删除(按照Pod->StatefulSet的顺序进行删除)
    {
        "kind": "DeleteOptions",
        "apiVersion": "v1",
        "propagationPolicy": "Foreground"
    }
  • 后台级联删除(按照StatefulSet->Pod的顺序进行删除)
    {
        "kind": "DeleteOptions",
        "apiVersion": "v1",
        "propagationPolicy": "Background"
    }

响应消息

响应参数:

响应参数的详细描述请参见表2

响应示例

{
    "kind": "Status",
    "apiVersion": "v1",
    "metadata": {},
    "status": "Success",
    "code": 200
}

状态码

表2描述API的状态码。

表2 状态码

状态码

描述

200

Delete a StatefulSet resource object successfully.

异常状态码请参见状态码

分享:

    相关文档

    相关产品