Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Zaku
GETZakuSince 1.0SynchronousAuth Required

GetServiceTopology

Get topology of backing pods for a Kubernetes service

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • serviceUuidStringRequired

    UUID of the Kubernetes service to retrieve topology for

Responses

200 OK

On success, this API returns the following response structure.

  • serviceObject

    Service for this resource

    • uuidString

      Unique identifier of the service

      Example: svc-001

    • nameString

      Name of the Kubernetes service

      Example: nginx-service

    • namespaceString

      Kubernetes namespace of the service

      Example: default

    • typeString

      Service type (ClusterIP, NodePort, LoadBalancer)

      Example: ClusterIP

    • clusterIpString

      Cluster-internal IP address assigned to the service

      Example: 10.96.0.10

    • portsString

      JSON-serialized port mappings for the service

      Example: [{"port":80,"targetPort":8080}]

    • selectorString

      Label selector expression for backing pods

      Example: app=nginx

  • podsList

    The pods value

    Example: (nested array)

    • uuidString

      Unique identifier of the pod

      Example: pod-001

    • nameString

      Name of the pod

      Example: nginx-deployment-abc123

    • namespaceString

      Kubernetes namespace of the pod

      Example: default

    • statusString

      Current status phase of the pod

      Example: Running

    • workloadNameString

      Name of the parent workload managing this pod

      Example: nginx-deployment

    • workloadKindString

      Kind of the parent workload (Deployment, StatefulSet, etc.)

      Example: Deployment

    • gpuUuidsList

      UUIDs of GPU cards assigned to this pod

      Example: item1,item2

Endpoint

GET/api/v1/zaku/services/{serviceUuid}/topology

/api/v1/zaku/services/{serviceUuid}/topology

Operation ID

GetServiceTopology

Permalink

Request Example

curl -X GET '{host}/api/v1/zaku/services/{serviceUuid}/topology' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "service": {},
  "pods": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history