Get Details for a Running Deployment
get
/api/microservice/Workload/readForDeploymentDetails
Gets the details for the deployment running at the specified path.
Request
Query Parameters
-
path(required): string
The full path, in /{cluster}/{namespace}/{deployment-name} format.Example:
/cluster-1/a1-cache/example-poller
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 deployment details. For full details, you can use the following command: a1k -n {namespace} -ojson get deployment {deployment-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 deployment details. For full details, you can use the following command:
a1k -n {namespace} -ojson get deployment {deployment-id}
Example:
{
"Annotations":{
"Annotations Details":"Value",
"Name":"example-poller",
"Namespace":"a1-cache",
"Created":"2023-10-21T11:20:46Z",
"Conditions":[
{
"lastTransitionTime":"2023-10-21T11:20:46Z",
"lastUpdateTime":"2023-10-21T11:20:47Z",
"message":"ReplicaSet \"example-poller-5749c48df5\" has successfully progressed.",
"reason":"NewReplicaSetAvailable",
"status":"True",
"type":"Progressing"
}
],
"Replicas":1,
"StrategyType":"RollingUpdate",
"Selector":{
"Selector Details":"Value"
},
"Labels":{
"Labels Details":"Value"
},
"Tolerations":null,
"CPU":[
],
"Memory":[
],
"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