This API is used to delete a Job.
DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}
Table 1 describes the parameters of this API.
Parameter |
Mandatory |
Description |
---|---|---|
pretty |
No |
If 'true', then the output is pretty printed. |
name |
Yes |
name of the Job |
namespace |
Yes |
object name and auth scope, such as for teams and projects |
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. 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 parameters:
Table 2 describes the request parameters.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
kind |
Yes |
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. |
apiVersion |
Yes |
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. The value of this parameter is v1. |
gracePeriodSeconds |
No |
Integer |
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. Value range of this parameter: > 0. |
preconditions |
No |
Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. |
|
orphanDependents |
No |
Boolean |
Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. |
propagationPolicy |
No |
String |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
uid |
No |
types.UID |
Specifies the target UID. |
Example request:
{ "kind": "DeleteOptions", "apiVersion": "v1", "gracePeriodSeconds": 0 }
Response parameters:
For the description about response parameters, see Table 4.
Example response:
{ "kind": "Job", "apiVersion": "batch/v1", "metadata": { "name": "jobs-12130306", "namespace": "ns-12130306-s", "selfLink": "/apis/batch/v1/namespaces/ns-12130306-s/jobs/jobs-12130306", "uid": "eed6b02b-dfb3-11e7-9c19-fa163e2d897b", "resourceVersion": "419072", "creationTimestamp": "2017-12-13T03:15:55Z", "deletionTimestamp": "2017-12-13T03:15:56Z", "deletionGracePeriodSeconds": 0, "labels": { "app": "new-jobs", "name": "job-test" }, "finalizers": [ "orphan" ], "enable": true }, "spec": { "parallelism": 1, "completions": 1, "selector": { "matchLabels": { "controller-uid": "eed6b02b-dfb3-11e7-9c19-fa163e2d897b" } }, "template": { "metadata": { "name": "jobs-12130306", "creationTimestamp": null, "labels": { "controller-uid": "eed6b02b-dfb3-11e7-9c19-fa163e2d897b", "job-name": "jobs-12130306", "name": "job-test" }, "enable": true }, "spec": { "containers": [ { "name": "jobs-12130306", "image": "172.16.5.235:20202/test/redis:latest", "resources": {}, "terminationMessagePath": "/dev/termination-log", "terminationMessagePolicy": "File", "imagePullPolicy": "Always" } ], "restartPolicy": "Never", "terminationGracePeriodSeconds": 30, "dnsPolicy": "ClusterFirst", "securityContext": {}, "schedulerName": "default-scheduler" } } }, "status": { "startTime": "2017-12-13T03:15:55Z", "active": 1 } }
Table 4 describes the status code of this API.
For the description about status codes, see section Status Codes.