Jump to

• Request
• Response

Get Details for a Running Pod

get

/api/microservice/Workload/readForPodDetails

Gets the details for the pod running at the specified path.

Request

Query Parameters

• path(required): string
  The full path, in /{cluster}/{namespace}/{pod-name} format.

  Example:

  /cluster-1/a1-cache/example-poller-5749c48df5-2mcpv

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: object

Show Source

• data: object data
  Returns a subset of Kubernetes pod details. For full details, you can use the following command: a1k -n {namespace} -ojson get pod {pod-id}
• message: string
  The response message in text.

  Example:
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message in text.",
            "type":"string",
            "example":""
        },
        "data":{
            "description":"Returns a subset of Kubernetes pod details. For full details, you can use the following command:\n<b>a1k -n {namespace} -ojson get pod {pod-id}</b>",
            "type":"object",
            "example":{
                "Labels":{
                    "Labels Details":"Value",
                    "Annotations":{
                        "Annotations Details":"Value"
                    },
                    "IP":"10.42.0.8",
                    "IPs":[
                        {
                            "ip":"10.42.0.8"
                        }
                    ],
                    "StartTime":"2023-08-04T10:59:14Z",
                    "Conditions":[
                        {
                            "lastProbeTime":null,
                            "lastTransitionTime":"2023-08-04T10:59:14Z",
                            "status":"True",
                            "type":"Initialized"
                        }
                    ],
                    "Tolerations":[
                        {
                            "effect":"NoExecute",
                            "key":"node.kubernetes.io/not-ready",
                            "operator":"Exists",
                            "tolerationSeconds":300
                        }
                    ],
                    "Node":"router.example.com",
                    "Priority":0,
                    "PriorityName":null,
                    "QoS":"BestEffort",
                    "Status":"Running",
                    "Owner":"ReplicaSet/pod-presets-webhook-66bcf77944",
                    "NodeSelector":null,
                    "InitContainers":[
                    ],
                    "Containers":{
                        "Container Details":"Value",
                        "Mounts":[
                            {
                                "mountPath":"/certs/a1",
                                "name":"a1-certs",
                                "readOnly":true
                            }
                        ],
                        "Command":null,
                        "Args":null,
                        "EnvVar":[
                            {
                                "name":"WEBHOOK_PORT",
                                "value":"8443"
                            },
                            {
                                "name":"DIRECTORY",
                                "value":"/Directorypath"
                            },
                            {
                                "name":"CLUSTER_NAME",
                                "value":"cluster-1"
                            }
                        ],
                        "Liveness":null,
                        "Readiness":null,
                        "Request":null,
                        "Ports":[
                            {
                                "containerPort":8443,
                                "protocol":"TCP"
                            }
                        ],
                        "Volumes":null
                    }
                },
                "Volumes":{
                    "a1-certs":"secret",
                    "ns-cert":"secret",
                    "a1-config":"[configMap] a1-config"
                },
                "Events":[
                ]
            }
        }
    }
}

Nested Schema : data

Type: object

Returns a subset of Kubernetes pod details. For full details, you can use the following command: a1k -n {namespace} -ojson get pod {pod-id}

Example:

{
    "Labels":{
        "Labels Details":"Value",
        "Annotations":{
            "Annotations Details":"Value"
        },
        "IP":"10.42.0.8",
        "IPs":[
            {
                "ip":"10.42.0.8"
            }
        ],
        "StartTime":"2023-08-04T10:59:14Z",
        "Conditions":[
            {
                "lastProbeTime":null,
                "lastTransitionTime":"2023-08-04T10:59:14Z",
                "status":"True",
                "type":"Initialized"
            }
        ],
        "Tolerations":[
            {
                "effect":"NoExecute",
                "key":"node.kubernetes.io/not-ready",
                "operator":"Exists",
                "tolerationSeconds":300
            }
        ],
        "Node":"router.example.com",
        "Priority":0,
        "PriorityName":null,
        "QoS":"BestEffort",
        "Status":"Running",
        "Owner":"ReplicaSet/pod-presets-webhook-66bcf77944",
        "NodeSelector":null,
        "InitContainers":[
        ],
        "Containers":{
            "Container Details":"Value",
            "Mounts":[
                {
                    "mountPath":"/certs/a1",
                    "name":"a1-certs",
                    "readOnly":true
                }
            ],
            "Command":null,
            "Args":null,
            "EnvVar":[
                {
                    "name":"WEBHOOK_PORT",
                    "value":"8443"
                },
                {
                    "name":"DIRECTORY",
                    "value":"/Directorypath"
                },
                {
                    "name":"CLUSTER_NAME",
                    "value":"cluster-1"
                }
            ],
            "Liveness":null,
            "Readiness":null,
            "Request":null,
            "Ports":[
                {
                    "containerPort":8443,
                    "protocol":"TCP"
                }
            ],
            "Volumes":null
        }
    },
    "Volumes":{
        "a1-certs":"secret",
        "ns-cert":"secret",
        "a1-config":"[configMap] a1-config"
    },
    "Events":[
    ]
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top