Deleting a Volcano Job

Function

This API is used to delete a specified Volcano job.

Calling Method

For details, see Calling APIs.

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
dryRun	No	String	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSeconds	No	Integer	The duration in seconds before the object should be deleted. Value must be 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	Boolean	Deprecated: please 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	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. 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.
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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
apiVersion	No	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
dryRun	No	Array of strings	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
gracePeriodSeconds	No	Long	The duration in seconds before the object should be deleted. Value must be 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.
kind	No	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
orphanDependents	No	Boolean	Deprecated: please 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.
preconditions	No	io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions object	Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
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. 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.

**Table 5** io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions
Parameter	Mandatory	Type	Description
resourceVersion	No	String	Specifies the target ResourceVersion
uid	No	String	Specifies the target UID.

Response Parameters

Status code: 200

**Table 6** 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 7** 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 8** 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 9** 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.

Status code: 202

**Table 10** 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 11** 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 12** 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 13** 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" : "v1",
  "details" : {
    "group" : "batch.volcano.sh",
    "kind" : "jobs",
    "name" : "openmpi-hello-3-com",
    "uid" : "1a32a8c4-97db-11e9-9d09-dc9914fb58e0"
  },
  "kind" : "Status",
  "metadata" : { },
  "status" : "Success"
}

Status Codes

Status Code	Description
200	OK
202	Accepted
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