Help Center>
Cloud Container Instance>
API Reference>
Out-of-Date APIs>
Kubernetes APIs (Discarded)>
MXJob>
Replacing an MXJob
Updated on 2023-12-21 GMT+08:00
Replacing an MXJob
Function
This function is used to replace a specified MXJob. The following fields can be replaced:
- metadata.labels
- metadata.annotations
- spec.activeDeadlineSeconds
- spec.ttlSecondsAfterFinished
- spec.cleanPodPolicy
URI
PUT /apis/kubeflow.org/v1/namespaces/{namespace}/mxjobs/{name}
Parameter |
Mandatory |
Description |
|---|---|---|
name |
Yes |
Name of the MXJob. |
namespace |
Yes |
Object name and auth scope, such as for teams and projects. |
Parameter |
Mandatory |
Description |
|---|---|---|
pretty |
No |
If 'true', then the output is pretty printed. |
Request
Request parameters
For the description about request parameters, see Table 162.
Example request
Change the ttlSecondsAfterFinished value of MXJob.
{
"apiVersion": "kubeflow.org/v1",
"kind": "MXJob",
"metadata": {
"creationTimestamp": "2019-07-29T03:34:33Z",
"generation": 2,
"name": "mxnet-job",
"namespace": "kube-test",
"resourceVersion": "75615427",
"selfLink": "/apis/kubeflow.org/v1/namespaces/kube-test/mxjobs/mxnet-job",
"uid": "c82e664f-b1b1-11e9-b310-b44326d0c915"
},
"spec": {
"cleanPodPolicy": "Running",
"jobMode": "MXTrain",
"mxReplicaSpecs": {
"Scheduler": {
"replicas": 1,
"restartPolicy": "Never",
"template": {
"spec": {
"containers": [
{
"args": [
"-c",
"python train_imagenet.py"
],
"command": [
"/bin/bash"
],
"image": "100.79.1.215:20202/paas_cci_w00427225/mxnet:xsw-dis",
"name": "mxnet",
"resources": {
"limits": {
"cpu": "1000m",
"memory": "2Gi"
},
"requests": {
"cpu": "1000m",
"memory": "2Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
]
}
}
},
"Server": {
"replicas": 1,
"restartPolicy": "Never",
"template": {
"spec": {
"containers": [
{
"args": [
"-c",
"python train_imagenet.py"
],
"command": [
"/bin/bash"
],
"image": "100.79.1.215:20202/paas_cci_w00427225/mxnet:xsw-dis",
"name": "mxnet",
"resources": {
"limits": {
"cpu": "1000m",
"memory": "2Gi"
},
"requests": {
"cpu": "1000m",
"memory": "2Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
]
}
}
},
"Worker": {
"replicas": 1,
"restartPolicy": "Never",
"template": {
"spec": {
"containers": [
{
"args": [
"-c",
"python train_imagenet.py --benchmark 1 --network resnet --batch-size 1 --num-epochs 1 --kv-store dist_sync --num-examples 500"
],
"command": [
"/bin/bash"
],
"image": "100.79.1.215:20202/paas_cci_w00427225/mxnet:xsw-dis",
"name": "mxnet",
"resources": {
"limits": {
"cpu": "1000m",
"memory": "2Gi"
},
"requests": {
"cpu": "1000m",
"memory": "2Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
]
}
}
}
},
"ttlSecondsAfterFinished": 10000
},
"status": {
"conditions": [
{
"lastTransitionTime": "2019-07-29T03:34:33Z",
"lastUpdateTime": "2019-07-29T03:34:33Z",
"message": "MXJob mxnet-job is created.",
"reason": "MXJobCreated",
"status": "True",
"type": "Created"
},
{
"lastTransitionTime": "2019-07-29T03:34:33Z",
"lastUpdateTime": "2019-07-29T03:35:22Z",
"message": "MXJob mxnet-job is running.",
"reason": "MXJobRunning",
"status": "True",
"type": "Running"
}
],
"mxReplicaStatuses": {
"Scheduler": {
"active": 1
},
"Server": {
"active": 1
},
"Worker": {
"active": 1
}
},
"startTime": "2019-07-29T03:34:33Z"
}
}
Response
Response parameters
For the description about response parameters, see Table 162.
Example response
{
"apiVersion": "kubeflow.org/v1",
"kind": "MXJob",
"metadata": {
"creationTimestamp": "2019-07-29T03:34:33Z",
"generation": 2,
"name": "mxnet-job",
"namespace": "kube-test",
"resourceVersion": "75615427",
"selfLink": "/apis/kubeflow.org/v1/namespaces/kube-test/mxjobs/mxnet-job",
"uid": "c82e664f-b1b1-11e9-b310-b44326d0c915"
},
"spec": {
"cleanPodPolicy": "Running",
"jobMode": "MXTrain",
"mxReplicaSpecs": {
"Scheduler": {
"replicas": 1,
"restartPolicy": "Never",
"template": {
"spec": {
"containers": [
{
"args": [
"-c",
"python train_imagenet.py"
],
"command": [
"/bin/bash"
],
"image": "100.79.1.215:20202/paas_cci_w00427225/mxnet:xsw-dis",
"name": "mxnet",
"resources": {
"limits": {
"cpu": "1000m",
"memory": "2Gi"
},
"requests": {
"cpu": "1000m",
"memory": "2Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
]
}
}
},
"Server": {
"replicas": 1,
"restartPolicy": "Never",
"template": {
"spec": {
"containers": [
{
"args": [
"-c",
"python train_imagenet.py"
],
"command": [
"/bin/bash"
],
"image": "100.79.1.215:20202/paas_cci_w00427225/mxnet:xsw-dis",
"name": "mxnet",
"resources": {
"limits": {
"cpu": "1000m",
"memory": "2Gi"
},
"requests": {
"cpu": "1000m",
"memory": "2Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
]
}
}
},
"Worker": {
"replicas": 1,
"restartPolicy": "Never",
"template": {
"spec": {
"containers": [
{
"args": [
"-c",
"python train_imagenet.py --benchmark 1 --network resnet --batch-size 1 --num-epochs 1 --kv-store dist_sync --num-examples 500"
],
"command": [
"/bin/bash"
],
"image": "100.79.1.215:20202/paas_cci_w00427225/mxnet:xsw-dis",
"name": "mxnet",
"resources": {
"limits": {
"cpu": "1000m",
"memory": "2Gi"
},
"requests": {
"cpu": "1000m",
"memory": "2Gi"
}
}
}
],
"imagePullSecrets": [
{
"name": "imagepull-secret"
}
]
}
}
}
},
"ttlSecondsAfterFinished": 10000
},
"status": {
"conditions": [
{
"lastTransitionTime": "2019-07-29T03:34:33Z",
"lastUpdateTime": "2019-07-29T03:34:33Z",
"message": "MXJob mxnet-job is created.",
"reason": "MXJobCreated",
"status": "True",
"type": "Created"
},
{
"lastTransitionTime": "2019-07-29T03:34:33Z",
"lastUpdateTime": "2019-07-29T03:35:22Z",
"message": "MXJob mxnet-job is running.",
"reason": "MXJobRunning",
"status": "True",
"type": "Running"
}
],
"mxReplicaStatuses": {
"Scheduler": {
"active": 1
},
"Server": {
"active": 1
},
"Worker": {
"active": 1
}
},
"startTime": "2019-07-29T03:34:33Z"
}
}
Status Code
Status Code |
Description |
|---|---|
200 |
OK |
201 |
Created |
401 |
Unauthorized |
400 |
BadRequest |
500 |
Internal Error |
403 |
Forbidden |
Parent topic: MXJob
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
The system is busy. Please try again later.
For any further questions, feel free to contact us through the chatbot.
Chatbot
