Get Details for a Running Cronjob
get
/api/microservice/Workload/readForCronJobDetails
Gets the details for the cronjob running at the specified path.
Request
Query Parameters
-
path(required): string
The full path, in /{cluster}/{namespace}/{cronjob-name} format.Example:
/cluster-1/a1-messaging/cronjob
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Type:
Show Source
object
-
data: object
data
Returns a subset of Kubernetes CronJob details. For full details, you can use the following command: a1k -n {namespace} -ojson get cronjob {cronjob-id}
-
message: string
The response message in text.Example:
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : data
Type:
object
Returns a subset of Kubernetes CronJob details. For full details, you can use the following command:
a1k -n {namespace} -ojson get cronjob {cronjob-id}
Example:
{
"Name":"Job Name",
"Namespace":"a1-messaging",
"Created":"2023-08-04T11:02:30Z",
"Annotations":{
"Annotations Details":"Value"
},
"Schedule":null,
"Suspend":null,
"Events":[
],
"Pods":{
"Pod Details":"Value"
}
}
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object