Deleting All Pods

Function

This API is used to delete all pods.

URI

DELETE /api/v1/namespaces/{namespace}/pods

Table 1 describes the parameters of this API.

Table 1 Parameter description

Parameters

Mandatory

Description

namespace

Yes

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

pretty

No

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

fieldSelector

No

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

No

If true, partially initialized resources are included in the response.

labelSelector

No

A selector to restrict the list of returned objects by their labels. Defaults to everything.

resourceVersion

No

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

No

Timeout for the list/watch call.

watch

No

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Request

N/A

Response

Response parameters:

For the description about response parameters, see Table 4.

Example response:

{
    "kind": "PodList",
    "apiVersion": "v1",
    "metadata": {
        "selfLink": "/api/v1/namespaces/delns-12130306/pods",
        "resourceVersion": "419153"
    },
    "items": [
        {
            "metadata": {
                "name": "pod-del-12130306",
                "namespace": "delns-12130306",
                "selfLink": "/api/v1/namespaces/delns-12130306/pods/pod-del-12130306",
                "uid": "026331da-dfb4-11e7-9c19-fa163e2d897b",
                "resourceVersion": "419153",
                "creationTimestamp": "2017-12-13T03:16:28Z",
                "labels": {
                    "cce/appgroup": "container"
                },
                "annotations": {
                    "kubernetes.io/availablezone": ""
                },
                "enable": true
            },
            "spec": {
                "volumes": [
                    {
                        "name": "default-token-zx6gk",
                        "secret": {
                            "secretName": "default-token-zx6gk",
                            "defaultMode": 384
                        }
                    }
                ],
                "containers": [
                    {
                        "name": "podcon-12130306",
                        "image": "172.16.5.235:20202/test/redis:v1",
                        "ports": [
                            {
                                "name": "tcp",
                                "containerPort": 80,
                                "protocol": "TCP"
                            }
                        ],
                        "resources": {},
                        "volumeMounts": [
                            {
                                "name": "default-token-zx6gk",
                                "readOnly": true,
                                "mountPath": "/var/run/secrets/kubernetes.io/serviceaccount"
                            }
                        ],
                        "terminationMessagePath": "/dev/termination-log",
                        "terminationMessagePolicy": "File",
                        "imagePullPolicy": "IfNotPresent"
                    }
                ],
                "restartPolicy": "Always",
                "terminationGracePeriodSeconds": 30,
                "dnsPolicy": "ClusterFirst",
                "serviceAccountName": "default",
                "serviceAccount": "default",
                "nodeName": "192.168.0.197",
                "securityContext": {},
                "schedulerName": "default-scheduler"
            },
            "status": {
                "phase": "Pending",
                "conditions": [
                    {
                        "type": "Initialized",
                        "status": "True",
                        "lastProbeTime": null,
                        "lastTransitionTime": "2017-12-13T03:16:28Z"
                    },
                    {
                        "type": "Ready",
                        "status": "False",
                        "lastProbeTime": null,
                        "lastTransitionTime": "2017-12-13T03:16:28Z",
                        "reason": "ContainersNotReady",
                        "message": "containers with unready status: [podcon-12130306]"
                    },
                    {
                        "type": "PodScheduled",
                        "status": "True",
                        "lastProbeTime": null,
                        "lastTransitionTime": "2017-12-13T03:16:28Z"
                    }
                ],
                "hostIP": "192.168.0.197",
                "managementIP": "192.168.0.197",
                "startTime": "2017-12-13T03:16:28Z",
                "containerStatuses": [
                    {
                        "name": "podcon-12130306",
                        "state": {
                            "waiting": {
                                "reason": "ContainerCreating"
                            }
                        },
                        "lastState": {},
                        "ready": false,
                        "restartCount": 0,
                        "image": "172.16.5.235:20202/test/redis:v1",
                        "imageID": ""
                    }
                ],
                "qosClass": "BestEffort"
            }
        }
    ]
}

Status Code

Table 2 describes the status code of this API.

Table 2 Status code

Status Code

Description

200

Delete a Pod resource object successfully.

For details about error status codes, see Status Code.