Get cluster namespace service exposure details

Get detailed information for the exposed service in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/services/{serviceName}

Path parameters

clusterId*string

namespaceName*string

serviceName*string

Response

Body

clusterIPstring

Example: "0.0.0.0"

creationTimestampstring

Example: "2023-04-29 05:54:51"

detailDetail (object)

annotationsobject

additionalPropstring

clusterIPstring

Example: "0.0.0.0"

creationTimestampstring

Example: "2023-04-29 05:54:51"

externalEndpointsarray of string

External endpoint list

itemsstring

internalEndpointsarray of string

internal endpoint list

itemsstring

Example: "agent-mdziow-3-alarm-agent.cocktail-addon:9301 TCP"

labelSelectorobject

additionalPropstring

labelsobject

additionalPropstring

namespacestring

namespace name

Example: "cocktail-system"

serviceNamestring

Example: "api-cmdb"

sessionAffinitystring

Session Affinity

Example: "None"

typestring

Service type

Example: "ClusterIP"

endpointsarray of object

Endpoint list

hoststring

portsarray of object

Port list

portinteger

protocolstring

readyboolean

Readiness status

eventsarray of Events (object)

Event information

messagestring

Example: "Readiness probe failed: command \"/bin/api-cmdb readiness\" timed out"

sourcestring

Example: ""

subObjectstring

Example: ""

countinteger

firstTimestring

Example: "2023-04-29 05:54:51"

lastTimestring

Example: "2023-06-20 06:35:03"

kindstring

Example: ""

namestring

Example: ""

namespacestring

namespace name

Example: "cocktail-system"

involvedObjectInvolvedObject (object)

apiVersionstring

Example: ""

fieldPathstring

Example: ""

kindstring

Example: ""

namestring

Example: ""

namespacestring

namespace name

Example: "cocktail-system"

resourceVersionstring

Resource type

Example: ""

uidstring

Example: ""

relatedRelated (object)

apiVersionstring

Example: ""

fieldPathstring

Example: ""

kindstring

Example: ""

namestring

Example: ""

namespacestring

namespace name

Example: "cocktail-system"

resourceVersionstring

Resource type

Example: ""

uidstring

Example: ""

deploymentstring

Event distribution information

Example: ""

deploymentYamlstring

Event distribution information (Yaml)

Example: ""

externalEndpointsarray of string

External endpoint list

itemsstring

Example: ""

internalEndpointsarray of string

Internal endpoint list

itemsstring

Example: "agent-mdziow-3-alarm-agent.cocktail-addon:0 TCP"

internalLBFlagboolean

Internal load balancer availability

Example: false

labelsobject

additionalPropstring

namespacestring

namespace name

Example: "cocktail-system"

serviceDeploymentstring

Service deployment information

Example: "{\"apiVersion\":\"v1\",\"kind\":\"Service\"..."

serviceDeploymentYamlstring

Service deployment information(YAML)

Example: "apiVersion: v1\nkind: Service\nmetadata:\n annotations:\n..."

serviceNamestring

Example: "agent-mdziow-3-alarm-agent"

sessionAffinitystring

Session Affinity

Example: "None"

Request

const response = await fetch('/v1/clusters/{clusterId}/namespaces/{namespaceName}/services/{serviceName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "clusterIP": "0.0.0.0",
  "creationTimestamp": "2023-04-29 05:54:51",
  "detail": {
    "annotations": {
      "meta.helm.sh/release-name": "cocktail",
      "meta.helm.sh/release-namespace": "cocktail-system"
    },
    "clusterIP": "0.0.0.0",
    "creationTimestamp": "2023-04-29 05:54:51",
    "externalEndpoints": [],
    "internalEndpoints": [
      "api-cmdb.cocktail-system:0 TCP"
    ],
    "labelSelector": {
      "app.kubernetes.io/instance": "cocktail",
      "app.kubernetes.io/name": "api-cmdb"
    },
    "labels": {
      "app": "cocktail-api-cmdb",
      "app.kubernetes.io/instance": "cocktail",
      "app.kubernetes.io/managed-by": "Helm"
    },
    "namespace": "cocktail-system",
    "serviceName": "api-cmdb",
    "sessionAffinity": "None",
    "type": "ClusterIP"
  },
  "endpoints": [
    {
      "host": "0.0.0.0",
      "ports": [
        {
          "port": "0",
          "protocol": "TCP"
        }
      ],
      "ready": true
    }
  ],
  "events": [
    {
      "message": "Readiness probe failed: command \"/bin/api-cmdb readiness\" timed out",
      "source": "",
      "subObject": "",
      "firstTime": "2023-04-29 05:54:51",
      "lastTime": "2023-06-20 06:35:03",
      "kind": "",
      "name": "",
      "namespace": "cocktail-system",
      "involvedObject": {
        "apiVersion": "",
        "fieldPath": "",
        "kind": "",
        "name": "",
        "namespace": "cocktail-system",
        "resourceVersion": "",
        "uid": ""
      },
      "related": {
        "apiVersion": "",
        "fieldPath": "",
        "kind": "",
        "name": "",
        "namespace": "cocktail-system",
        "resourceVersion": "",
        "uid": ""
      },
      "deployment": "",
      "deploymentYaml": ""
    }
  ],
  "externalEndpoints": [
    ""
  ],
  "internalEndpoints": [
    "agent-mdziow-3-alarm-agent.cocktail-addon:0 TCP"
  ],
  "internalLBFlag": false,
  "labels": {
    "app.kubernetes.io/instance": "agent-mdziow-3",
    "app.kubernetes.io/managed-by": "Helm",
    "...": "..."
  },
  "namespace": "cocktail-system",
  "serviceDeployment": "{\"apiVersion\":\"v1\",\"kind\":\"Service\"...",
  "serviceDeploymentYaml": "apiVersion: v1\nkind: Service\nmetadata:\n  annotations:\n...",
  "serviceName": "agent-mdziow-3-alarm-agent",
  "sessionAffinity": "None"
}