Help Center> Cloud Container Instance (CCI)> API Reference> Out-of-Date APIs> Kubernetes APIs (Discarded)> Statefulset> Deleting a StatefulSet
View PDF

Deleting a StatefulSet

Function

This API is used to delete a StatefulSet.

URI

DELETE /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}

Table 1 describes the parameters of this API.

Table 1 Parameter description

Parameter

Mandatory

Description

name

Yes

Name of the StatefulSet.

namespace

Yes

Namespace to which the StatefulSet you want to delete belongs.

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. The value 0 indicates to 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.

Request

Request parameters

For the description about request parameters, see Table 64.

Example request

  • Deleting only the StatefulSet (the pod is not deleted): 
    {
    "Kind": "DeleteOptions",
    "apiVersion": "v1",
    "propagationPolicy": "Orphan"
}
  • Deleting the pod and then the StatefulSet: 
    {
    "kind": "DeleteOptions",
    "apiVersion": "v1",
    "propagationPolicy": "Foreground"
}
  • Deleting the StatefulSet and then the pod: 
    {
    "kind": "DeleteOptions",
    "apiVersion": "v1",
    "propagationPolicy": "Background"
}

Response

Response parameters

For the description about response parameters, see Table 52.

Example response

{
    "kind": "Status", 
    "apiVersion": "v1", 
    "metadata": {}, 
    "status": "Success", 
    "details": {
        "name": "statefulset-test", 
        "group": "apps", 
        "kind": "statefulsets", 
        "uid": "ee0ef0d0-2728-11e8-8930-84a9c46e8ca3"
    }, 
    "code": 200
}

Status Code

Table 2 describes the status code of this API.

Table 2 Status code

Status Code

Description

200

A StatefulSet resource object is deleted successfully.

For more status codes, see Status Codes.

Parent topic: Statefulset