Deleting Volcano Jobs in a Specified Namespace

Function

This API is used to delete all Volcano jobs in a specified namespace.

Calling Method

For details, see Calling APIs.

URI

DELETE /apis/batch.volcano.sh/v1alpha1/namespaces/{namespace}/jobs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
namespace	Yes	String	object name and auth scope, such as for teams and projects

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
allowWatchBookmarks	No	Boolean	allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.
continue	No	String	The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
fieldSelector	No	String	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	No	String	A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit	No	Integer	limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
resourceVersion	No	String	resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
resourceVersionMatch	No	String	resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset
timeoutSeconds	No	Integer	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch	No	Boolean	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
pretty	No	String	If 'true', then the output is pretty printed.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained through the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	Message body type (format). The default value is application/json. Default: application/json

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
apiVersion	String	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
code	Integer	Suggested HTTP return code for this status, 0 if not set.
details	io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails object	Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
kind	String	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
message	String	A human-readable description of the status of this operation.
metadata	io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta object	Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
reason	String	A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
status	String	Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

**Table 5** io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails
Parameter	Type	Description
causes	Array of io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause objects	The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
group	String	The group attribute of the resource associated with the status StatusReason.
kind	String	The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name	String	The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
retryAfterSeconds	Integer	If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action for those errors this field may indicate how long to wait before taking the alternate action.
uid	String	UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

**Table 6** io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause
Parameter	Type	Description
field	String	The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
message	String	A human-readable description of the cause of the error. This field may be presented as-is to a reader.
reason	String	A machine-readable description of the cause of the error. If this value is empty there is no information available.

**Table 7** io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta
Parameter	Type	Description
continue	String	continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
remainingItemCount	Long	remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is estimating the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
resourceVersion	String	String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
selfLink	String	selfLink is a URL representing this object. Populated by the system. Read-only. DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.

Example Requests

None

Example Responses

Status code: 200

{
  "apiVersion" : "batch.volcano.sh/v1alpha1",
  "items" : [ {
    "apiVersion" : "batch.volcano.sh/v1alpha1",
    "kind" : "Job",
    "metadata" : {
      "creationTimestamp" : "2019-06-26T03:16:26Z",
      "generation" : 1,
      "labels" : {
        "app" : "patchlabel"
      },
      "name" : "openmpi-hello-2-com",
      "namespace" : "cci-namespace-42263891",
      "resourceVersion" : "7695210",
      "selfLink" : "/apis/batch.volcano.sh/v1alpha1/namespaces/cci-namespace-42263891/jobs/openmpi-hello-2-com",
      "uid" : "c84d86f0-97c0-11e9-9d09-dc9914fb58e0"
    },
    "spec" : {
      "minAvailable" : 1,
      "plugins" : {
        "env" : [ ],
        "ssh" : [ ],
        "svc" : [ ]
      },
      "queue" : "default",
      "schedulerName" : "volcano",
      "tasks" : [ {
        "name" : "mpimaster",
        "policies" : [ {
          "action" : "CompleteJob",
          "event" : "TaskCompleted"
        } ],
        "replicas" : 1,
        "template" : {
          "spec" : {
            "containers" : [ {
              "command" : [ "/bin/sh", "-c", "MPI_HOST=`cat /etc/volcano/mpiworker.host | tr \"\\n\" \",\"`;\nmkdir -p /var/run/sshd; /usr/sbin/sshd;\nmpiexec --allow-run-as-root --host ${MPI_HOST} -np 2 mpi_hello_world 003e /home/re" ],
              "image" : "*.*.*.*:20202/l00427178/openmpi-hello:3.28",
              "name" : "mpimaster",
              "ports" : [ {
                "containerPort" : 22,
                "name" : "mpijob-port"
              } ],
              "resources" : {
                "limits" : {
                  "cpu" : "250m",
                  "memory" : "1Gi"
                },
                "requests" : {
                  "cpu" : "250m",
                  "memory" : "1Gi"
                }
              },
              "workingDir" : "/home"
            } ],
            "imagePullSecrets" : [ {
              "name" : "imagepull-secret"
            } ],
            "restartPolicy" : "OnFailure"
          }
        }
      }, {
        "name" : "mpiworker",
        "replicas" : 2,
        "template" : {
          "spec" : {
            "containers" : [ {
              "command" : [ "/bin/sh", "-c", "mkdir -p /var/run/sshd; /usr/sbin/sshd -D;" ],
              "image" : "*.*.*.*:20202/l00427178/openmpi-hello:3.28",
              "name" : "mpiworker",
              "ports" : [ {
                "containerPort" : 22,
                "name" : "mpijob-port"
              } ],
              "resources" : {
                "limits" : {
                  "cpu" : "250m",
                  "memory" : "1Gi"
                },
                "requests" : {
                  "cpu" : "250m",
                  "memory" : "1Gi"
                }
              },
              "workingDir" : "/home"
            } ],
            "imagePullSecrets" : [ {
              "name" : "imagepull-secret"
            } ],
            "restartPolicy" : "OnFailure"
          }
        }
      } ]
    },
    "status" : {
      "minAvailable" : 1,
      "pending" : 3,
      "state" : {
        "phase" : "Inqueue"
      }
    }
  } ],
  "kind" : "JobList",
  "metadata" : {
    "continue" : "",
    "resourceVersion" : "7732232",
    "selfLink" : "/apis/batch.volcano.sh/v1alpha1/namespaces/cci-namespace-42263891/jobs"
  }
}

Status Codes

Status Code	Description
200	OK
400	BadRequest
401	Unauthorized
403	Forbidden
404	NotFound
405	MethodNotAllowed
406	NotAcceptable
409	Conflict
415	UnsupportedMediaType
422	Invalid
429	TooManyRequests
500	InternalError
503	ServiceUnavailable
504	ServerTimeout