Help Center> Cloud Container Instance (CCI)> API Reference> Kubernetes-native APIs> PyTorchJob> Deleting a PyTorchJob
View PDF

Deleting a PyTorchJob

Function

This API is used to delete a specified PyTorchJob.

URI

DELETE /apis/kubeflow.org/v1/namespaces/{namespace}/pytorchjobs/{name}

Table 1 Path parameters

Parameter

Mandatory

Description

name

Yes

Name of the PyTorchJob.

namespace

Yes

Object name and auth scope, such as for teams and projects.
Table 2 Query parameters

Parameter

Mandatory

Description

dryRun

No

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

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: 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

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

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

Request

N/A

Response

Response parameters

For the description about response parameters, see Table 72.

Example response

{
    "kind": "Status",
    "apiVersion": "v1",
    "metadata": {},
    "status": "Success",
    "details": {
        "name": "pytorch-test",
        "group": "kubeflow.org",
        "kind": "pytorchjobs",
        "uid": "be7696f9-adfe-11e9-aaa4-340a9837e413"
    }
}

Status Code

Table 3 Status codes

Status Code

Description

200

OK

202

Accepted

401

Unauthorized

500

Internal Error

403

Forbidden
Parent topic: PyTorchJob