Reading All TFJobs Under a Specified Namespace

Function

This API is used to read the details about all TFJobs under a specified namespace.

URI

GET /apis/kubeflow.org/v1/namespaces/{namespace}/tfjobs

**Table 1** Path parameter
Parameter	Mandatory	Description
namespace	Yes	Object name and auth scope, such as for teams and projects.

**Table 2** Query parameters
Parameter	Mandatory	Description
fieldSelector	No	A selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelector	No	A selector to restrict the list of returned objects by their labels. Defaults to everything.
limit	No	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 number 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	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. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it is 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
timeoutSeconds	No	Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
watch	No	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Request

N/A

Response

Response parameters

For the description about response parameters, see Table 168.

Example response

{
    "apiVersion": "kubeflow.org/v1",
    "items": [
        {
            "apiVersion": "kubeflow.org/v1",
            "kind": "TFJob",
            "metadata": {
                "creationTimestamp": "2019-07-23T12:39:47Z",
                "generation": 1,
                "name": "tfjob-test",
                "namespace": "kube-test",
                "resourceVersion": "72050567",
                "selfLink": "/apis/kubeflow.org/v1/namespaces/kube-test/tfjobs/tfjob-test",
                "uid": "f461f966-ad46-11e9-aaa4-340a9837e413"
            },
            "spec": {
                "backoffLimit": 6,
                "tfReplicaSpecs": {
                    "Ps": {
                        "replicas": 1,
                        "template": {
                            "spec": {
                                "containers": [
                                    {
                                        "args": [
                                            "python",
                                            "/opt/tf-benchmarks/scripts/tf_cnn_benchmarks/tf_cnn_benchmarks.py",
                                            "--batch_size=1",
                                            "--model=resnet50",
                                            "--variable_update=parameter_server",
                                            "--flush_stdout=true",
                                            "--num_gpus=1",
                                            "--local_parameter_device=cpu",
                                            "--device=cpu",
                                            "--data_format=NHWC"
                                        ],
                                        "image": "*.*.*.215:20202/cci/tf-benchmarks-cpu:v1",
                                        "name": "tensorflow",
                                        "ports": [
                                            {
                                                "containerPort": 2222,
                                                "name": "tfjob-port"
                                            }
                                        ],
                                        "resources": {
                                            "limits": {
                                                "cpu": "2",
                                                "memory": "4Gi"
                                            },
                                            "requests": {
                                                "cpu": "2",
                                                "memory": "4Gi"
                                            }
                                        }
                                    }
                                ],
                                "imagePullSecrets": [
                                    {
                                        "name": "imagepull-secret"
                                    }
                                ],
                                "restartPolicy": "OnFailure"
                            }
                        }
                    },
                    "Worker": {
                        "replicas": 1,
                        "template": {
                            "spec": {
                                "containers": [
                                    {
                                        "args": [
                                            "python",
                                            "/opt/tf-benchmarks/scripts/tf_cnn_benchmarks/tf_cnn_benchmarks.py",
                                            "--batch_size=1",
                                            "--model=resnet50",
                                            "--variable_update=parameter_server",
                                            "--flush_stdout=true",
                                            "--local_parameter_device=cpu",
                                            "--device=cpu",
                                            "--data_format=NHWC"
                                        ],
                                        "image": "*.*.*.215:20202/cci/tf-benchmarks-cpu:v1",
                                        "name": "tensorflow",
                                        "ports": [
                                            {
                                                "containerPort": 2222,
                                                "name": "tfjob-port"
                                            }
                                        ],
                                        "resources": {
                                            "limits": {
                                                "cpu": "2",
                                                "memory": "4Gi"
                                            },
                                            "requests": {
                                                "cpu": "2",
                                                "memory": "4Gi"
                                            }
                                        }
                                    }
                                ],
                                "imagePullSecrets": [
                                    {
                                        "name": "imagepull-secret"
                                    }
                                ],
                                "restartPolicy": "OnFailure"
                            }
                        }
                    }
                }
            },
            "status": {
                "conditions": [
                    {
                        "lastTransitionTime": "2019-07-23T12:38:58Z",
                        "lastUpdateTime": "2019-07-23T12:38:58Z",
                        "message": "TFJob tfjob-test is created.",
                        "reason": "TFJobCreated",
                        "status": "True",
                        "type": "Created"
                    },
                    {
                        "lastTransitionTime": "2019-07-23T12:39:30Z",
                        "lastUpdateTime": "2019-07-23T12:39:30Z",
                        "message": "TFJob tfjob-test is running.",
                        "reason": "TFJobRunning",
                        "status": "True",
                        "type": "Running"
                    }
                ],
                "replicaStatuses": {
                    "PS": {
                        "active": 1
                    },
                    "Worker": {
                        "active": 1
                    }
                },
                "startTime": "2019-07-23T12:38:58Z"
            }
        }
    ],
    "kind": "TFJobList",
    "metadata": {
        "continue": "",
        "resourceVersion": "72353810",
        "selfLink": "/apis/kubeflow.org/v1/namespaces/kube-test/tfjobs"
    }
}