Help Center> Cloud Container Engine> API Reference> Kubernetes APIs> Job> Listing All Jobs
View PDF

Listing All Jobs

Function

This API is used to obtain a Job list.

URI

GET /apis/batch/v1/jobs

Table 1 describes the parameters of this API.

Table 1 Description

Parameter

Mandatory

Description

pretty

No

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

labelSelector

No

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

includeUninitialized

No

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

fieldSelector

No

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

watch

No

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

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.

timeoutSeconds

No

Timeout for the list/watch call.

Request

N/A

Response

Response parameters:

For the description about response parameters, see Table 4.

Example response:

{
    "kind": "JobList",
    "apiVersion": "batch/v1",
    "metadata": {
        "selfLink": "/apis/batch/v1/jobs",
        "resourceVersion": "419065"
    },
    "items": [
        {
            "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": "419064",
                "creationTimestamp": "2017-12-13T03:15:55Z",
                "labels": {
                    "name": "job-test"
                },
                "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
            }
        }
    ]
}

Status Code

Table 2 describes the status code of this API.

Table 2 Status code

Status Code

Description

200

This operation succeeds, and the Job of a group of Pod objects are returned.

For the description about error status codes, see Status Code.

Parent topic: Job