1 of 44

Cluster

Get clusters list

Get clusters status list

Get cluster details

Get cluster nodes list

Get cluster node details

Get cluster node events list

Get cluster storage list

Get cluster storage details

Get cluster ingress list

Get cluster service exposures list

Get cluster configuration list

Get cluster workloads list

Get cluster pods list

Get cluster PVC list

Get cluster CRD list

Get cluster addon list

Get cluster package list

Get cluster namespace list

Get cluster namespace details

Get cluster namespace ingress list

Get cluster namespace ingress details

Get cluster namespace service exposure list

Get cluster namespace service exposure details

Get cluster namespace configmap list

Get cluster namespace configmap details

Get cluster namespace secret list

Get cluster namespace secret details

Get cluster namespace PVC list

Get cluster namespace PVC details

Get cluster namespace Cronjobs list

Get cluster namespace Cronjob details

Get cluster namespace DaemonSets list

Get cluster namespace DaemonSet details

Get cluster namespace Deployments list

Get cluster namespace Deployment details

Get cluster namespace HAPs list

Get cluster namespace Jobs list

Get cluster namespace Job details

Get cluster namespace ReplicaSets list

Get cluster namespace StatefulSets list

Get cluster namespace StatefulSet details

Get cluster namespace pods logs

Get cluster namespace Container log

Get clusters list

Get the list of clusters.

GET/v1/clusters

Response

Body

apiUrlstring

Example: "https://0.0.0.0:0"

authTypestring

Authentication type(TOKEN, CERT, PLAIN)

Example: "CERT"

clusterIdstring

Example: "thingcluster"

clusterNamestring

Example: "devops cluster"

clusterSeqinteger

Example: 1

clusterStatestring

clusterState(RUNNING, STOPPED)

Example: "RUNNING"

createdstring

Creation date/time

Example: "2022-12-16 08:16:50"

cubeTypestring

Cube clustertype(ECS, EKS, ACS, AKS, GKE, TKE, OCP, OKE, MANAGED, PROVIDER)

Example: "MANAGED"

descriptionstring

Example: ""

ingressSupportedstring

Ingress support availability(Y: Allowed, N: Not allowed)

Example: "Y"

k8sVersionstring

Example: "1.23.14"

loadbalancerSupportedstring

Load balancer support availability(Y: Allowed, N: Not allowed)

Example: "N"

nodePortRangestring

Node port range(required if supporting node ports)

Example: "30000-32767"

nodePortSupportedstring

Node port support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortUrlstring

Example: "0.0.0.0"

persistentVolumeSupportedstring

Volume request support availability(Y: Allowed, N: Not allowed)

Example: "Y"

providerAccountSeqinteger

Example: 1

regionCodestring

Example: "Default"

updatedstring

Modification time

Example: "2023-06-13 09:34:39"

useYnstring

Availability(Y: Allowed, N: Not allowed)

Example: "Y"

Request

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

Response

[
  {
    "apiUrl": "https://0.0.0.0:0",
    "authType": "CERT",
    "clusterId": "thingcluster",
    "clusterName": "devops cluster",
    "clusterSeq": 1,
    "clusterState": "RUNNING",
    "created": "2022-12-16 08:16:50",
    "cubeType": "MANAGED",
    "description": "",
    "ingressSupported": "Y",
    "k8sVersion": "1.23.14",
    "loadbalancerSupported": "N",
    "nodePortRange": "30000-32767",
    "nodePortSupported": "Y",
    "nodePortUrl": "0.0.0.0",
    "persistentVolumeSupported": "Y",
    "providerAccountSeq": 1,
    "regionCode": "Default",
    "updated": "2023-06-13 09:34:39",
    "useYn": "Y"
  }
]

Get clusters status list

Get the status of all clusters.

GET/v1/clusters/conditions

Response

Body

accountAccount (object)

accountCodestring

Example: "DEVOPS"

accountNamestring

Example: "DEVOPS"

accountSeqinteger

Example: 1

accountTypestring

accountType(CCO, ENT, OEM, APP, CBE)

Example: "ENT"

baseLanguagestring

baseLanguage(ko, en, ja, zh)

Example: "ko"

concurrentSessionYnstring

Allow concurrent sessions(Y: Allowed, N: Not allowed)

Example: "Y"

descriptionstring

Example: ""

organizationNameinteger

Account organization name

Example: "DEVOPS"

userAuthTypestring

User authentication type(PLAIN, AAD, AD)

Example: "PLAIN"

apiUrlstring

Example: "https://0.0.0.0:0"

authTypestring

authType(TOKEN, CERT, PLAIN)

Example: "CERT"

clusterIdstring

Example: "thingcluster"

clusterNamestring

Example: "devops cluster"

clusterSeqinteger

Example: 1

clusterStatestring

clusterState(RUNNING, STOPPED)

Example: "RUNNING"

createdstring

Creation date/time

Example: "2022-12-16 08:16:50"

cubeTypestring

cube ClusterType(ECS, EKS, ACS, AKS, GKE, TKE, OCP, OKE, MANAGED, PROVIDER)

Example: "MANAGED"

descriptionstring

Example: ""

ingressSupportedstring

Ingress support availability(Y: Allowed, N: Not allowed)

Example: "Y"

k8sVersionstring

Example: "1.23.14"

loadbalancerSupportedstring

Load balancer support availability(Y: Allowed, N: Not allowed)

Example: "N"

nodePortRangestring

Node port range(required if supporting node ports)

Example: "30000-32767"

nodePortSupportedstring

Node port support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortUrlstring

Example: "0.0.0.0"

persistentVolumeSupportedstring

Volume request support availability(Y: Allowed, N: Not allowed)

Example: "Y"

providerAccountProviderAccount (object)

descriptionstring

Example: ""

providerCodestring

Example: "IDC"

providerCodeNamestring

Example: "Datacenter"

providerNamestring

Example: "thingcluster"

seqinteger

Example: 1

useTypestring

Provider type(METERING, USER, ACCESS_KEY)

Example: "USER"

regionCodestring

Example: "Default"

updatedstring

Modification time

Example: "2023-06-13 09:34:39"

useYnstring

Availability (Y: Allowed, N: Not allowed)

Example: "Y"

Request

Response

Get cluster details

Get the cluster details.

GET/v1/clusters/{clusterId}

Path parameters

clusterId*string

Response

Body

apiUrlstring

Example: "https://0.0.0.0:0"

authTypestring

authentication type(TOKEN, CERT, PLAIN)

Example: "CERT"

clusterIdstring

Example: "thingcluster"

clusterNamestring

Example: "devops cluster"

clusterSeqinteger

Example: 1

clusterStatestring

clusterState(RUNNING, STOPPED)

Example: "RUNNING"

countOfNamespaceinteger

Example: 22

countOfNodeinteger

Example: 7

countOfStaticVolumeinteger

Example: 0

countOfStorageClassinteger

Example: 2

countOfVolumeinteger

Example: 48

createdstring

Creation date/time

Example: "2022-12-16 08:16:50"

cubeTypestring

Cube cluster type(ECS, EKS, ACS, AKS, GKE, TKE, OCP, OKE, MANAGED, PROVIDER)

Example: "MANAGED"

descriptionstring

Example: ""

ingressSupportedstring

Ingress support availability(Y: Allowed, N: Not allowed)

Example: "Y"

k8sVersionstring

Example: "1.23.14"

loadbalancerSupportedstring

Load balancer support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortRangestring

Node port range(required if supporting node ports)

Example: "30000-32767"

nodePortSupportedstring

Node port support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortUrlstring

Example: "0.0.0.0"

persistentVolumeSupportedstring

Volume request support availability(Y: Allowed, N: Not allowed)

Example: "Y"

providerAccountProviderAccount (object)

descriptionstring

Example: ""

providerCodestring

Example: "IDC"

providerCodeNamestring

Example: "Datacenter"

providerNamestring

Example: "thingcluster"

seqinteger

Example: 1

useTypestring

Provider type(METERING, USER, ACCESS_KEY)

Example: "USER"

regionCodestring

Example: "KR"

updatedstring

Modification time

Example: "2023-06-13 09:34:39"

useYnstring

Availability(Y: Allowed, N: Not allowed)

Example: "Y"

Request

Response

Get cluster storage details

Get the storage details of the cluster.

GET/v1/clusters/{clusterId}/storages/{storageName}

Path parameters

clusterId*string

storagesName*string

Response

Body

annotationsobject

additionalPropstring

baseStorageYnstring

Default storage availability (Y: Allowed, N: Not allowed)

Example: "Y"

descriptionstring

Example: ""

labesobject

additionalPropstring

mountOptionsarray of string

Mount options list

itemsstring

namestring

Storage name

Example: "nfs-csi"

parametersarray of object

Parameter list

namestring

Parameter name

valuestring

Parameter value

phasestring

Volume status(Only used in Static Volume)(UNKNOWN, AVAILABLE, BOUND, RELEASED, FAILED, DELETED)

Example: "AVAILABLE"

pluginstring

Example: "NFS_CSI"

provisionerNamestring

Example: "nfs.csi.k8s.io"

readOnlyManyYnstring

Volume request ReadOnlyMany support availability (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteManyYnstring

Volume request ReadWriteMany support availability (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteOnceYnstring

Volume request readWriteOnceYn support availability (Y: Allowed, N: Not allowed)

Example: "Y"

reclaimPolicystring

reclaimPolicy(RECYCLE, RETAIN, DELETE, RECYCLE, RETAIN, DELETE)

Example: "RETAIN"

storageClassStorageClass (object)

creationTimestampstring

Example: "2022-12-02 02:16:03"

deploymentstring

Deployment information

Example: "{\"apiVersion\":\"storage.k8s.io/v1\",\"kind\":\"StorageClass\"..."

deploymentYamlstring

Deployment information(YAML)

Example: "apiVersion: storage.k8s.io/v1\nkind: StorageClass\n..."

detailobject

Detailed information

additionalPropany

labesobject

additionalPropstring

namestring

Storage name

Example: "nfs-csi"

parametersarray of object

Parameter list

namestring

Parameter name

valuestring

Parameter value

provisionerstring

Provisioner

Example: "nfs.csi.k8s.io"

storageTypestring

storageType(BLOCK, NETWORK, BLOCK, NETWORK)

Example: "NETWORK"

totalCapacityinteger

Example: 1024

typestring

Configuration type(None, HOST_PATH, EMPTY_DIR, CONFIG_MAP, SECRET, PERSISTENT_VOLUME_STATIC, PERSISTENT_VOLUME_LINKED, PERSISTENT_VOLUME)

Example: "PERSISTENT_VOLUME"

volumeBindingModestring

volumeBindingMode(IMMEDIATE, WAIT_FOR_FIRST_CONSUMER, IMMEDIATE, WAIT_FOR_FIRST_CONSUMER)

Example: "IMMEDIATE"

Request

const response = await fetch('/v1/clusters/{clusterId}/storages/{storageName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "annotations": {
    "cocktail-user-description": "bmZzLWNzaQ==",
    "meta.helm.sh/release-name": "default-storage",
    "meta.helm.sh/release-namespace": "kube-system"
  },
  "baseStorageYn": "Y",
  "description": "",
  "labes": {
    "acornsoft.io/provisioner-type": "NFS_CSI",
    "acornsoft.io/total-capacity": "1024",
    "acornsoft.io/type": "NETWORK"
  },
  "mountOptions": [
    "hard",
    "nfsvers=4.1"
  ],
  "name": "nfs-csi",
  "parameters": [
    {
      "name": "server",
      "value": "0.0.0.0"
    }
  ],
  "phase": "AVAILABLE",
  "plugin": "NFS_CSI",
  "provisionerName": "nfs.csi.k8s.io",
  "readOnlyManyYn": "Y",
  "readWriteManyYn": "Y",
  "readWriteOnceYn": "Y",
  "reclaimPolicy": "RETAIN",
  "storageClass": {
    "creationTimestamp": "2022-12-02 02:16:03",
    "deployment": "{\"apiVersion\":\"storage.k8s.io/v1\",\"kind\":\"StorageClass\"...",
    "deploymentYaml": "apiVersion: storage.k8s.io/v1\nkind: StorageClass\n...",
    "detail": {
      "annotations": {
        "cocktail-user-description": "bmZzLWNzaQ==",
        "meta.helm.sh/release-name": "default-storage",
        "meta.helm.sh/release-namespace": "kube-system"
      },
      "creationTime": "2022-12-02 02:16:03",
      "labels": {
        "acornsoft.io/provisioner-type": "NFS_CSI",
        "acornsoft.io/total-capacity": "1024",
        "acornsoft.io/type": "NETWORK"
      },
      "mountOptions": [
        "hard",
        "nfsvers=4.1"
      ],
      "name": "nfs-csi",
      "parameters": {
        "server": "0.0.0.0",
        "share": "/thingcluster"
      },
      "provisioner": "nfs.csi.k8s.io",
      "reclaimPolicy": "Retain",
      "volumeBindingMode": "Immediate"
    },
    "labes": {
      "acornsoft.io/provisioner-type": "NFS_CSI",
      "acornsoft.io/total-capacity": "1024",
      "acornsoft.io/type": "NETWORK"
    },
    "name": "nfs-csi",
    "parameters": [
      {
        "name": "server",
        "value": "0.0.0.0"
      }
    ],
    "provisioner": "nfs.csi.k8s.io"
  },
  "storageType": "NETWORK",
  "totalCapacity": 1024,
  "type": "PERSISTENT_VOLUME",
  "volumeBindingMode": "IMMEDIATE"
}

Get cluster node events list

Return the cluster node event list.

GET/v1/clusters/{clusterId}/nodes/{nodeName}/event

Path parameters

clusterId*string

nodeName*string

Response

Body

countinteger

deploymentstring

Event deployment information

Example: ""

deploymentYamlstring

Event deployment information(YAML)

Example: ""

firstTimestring

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

involvedObjectInvolvedObject (object)

apiVersionstring

Example: ""

fieldPathstring

Example: ""

kindstring

Example: ""

namestring

Example: ""

namespacestring

namespace name

Example: "cocktail-system"

resourceVersionstring

Resource type

Example: ""

uidstring

UID

Example: ""

kindstring

Example: ""

lastTimestring

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

messagestring

Example: ""

namestring

Event name

Example: ""

namespacestring

namespace name

Example: "cocktail-system"

relatedRelated (object)

apiVersionstring

Example: ""

fieldPathstring

Example: ""

kindstring

Example: ""

namestring

Example: ""

namespacestring

namespace name

Example: "cocktail-system"

resourceVersionstring

Resource type

Example: ""

uidstring

UID

Example: ""

sourcestring

Example: ""

subObjectstring

Example: ""

Request

const response = await fetch('/v1/clusters/{clusterId}/nodes/{nodeName}/event', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "deployment": "",
    "deploymentYaml": "",
    "firstTime": "2023-04-29 05:54:51",
    "involvedObject": {
      "apiVersion": "",
      "fieldPath": "",
      "kind": "",
      "name": "",
      "namespace": "cocktail-system",
      "resourceVersion": "",
      "uid": ""
    },
    "kind": "",
    "lastTime": "2023-04-29 05:54:53",
    "message": "",
    "name": "",
    "namespace": "cocktail-system",
    "related": {
      "apiVersion": "",
      "fieldPath": "",
      "kind": "",
      "name": "",
      "namespace": "cocktail-system",
      "resourceVersion": "",
      "uid": ""
    },
    "source": "",
    "subObject": ""
  }
]

Get clusters list

Get the list of clusters.

GET/v1/clusters

Response

Body

apiUrlstring

Example: "https://0.0.0.0:0"

authTypestring

Authentication type(TOKEN, CERT, PLAIN)

Example: "CERT"

clusterIdstring

Example: "thingcluster"

clusterNamestring

Example: "devops cluster"

clusterSeqinteger

Example: 1

clusterStatestring

clusterState(RUNNING, STOPPED)

Example: "RUNNING"

createdstring

Creation date/time

Example: "2022-12-16 08:16:50"

cubeTypestring

Cube clustertype(ECS, EKS, ACS, AKS, GKE, TKE, OCP, OKE, MANAGED, PROVIDER)

Example: "MANAGED"

descriptionstring

Example: ""

ingressSupportedstring

Ingress support availability(Y: Allowed, N: Not allowed)

Example: "Y"

k8sVersionstring

Example: "1.23.14"

loadbalancerSupportedstring

Load balancer support availability(Y: Allowed, N: Not allowed)

Example: "N"

nodePortRangestring

Node port range(required if supporting node ports)

Example: "30000-32767"

nodePortSupportedstring

Node port support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortUrlstring

Example: "0.0.0.0"

persistentVolumeSupportedstring

Volume request support availability(Y: Allowed, N: Not allowed)

Example: "Y"

providerAccountSeqinteger

Example: 1

regionCodestring

Example: "Default"

updatedstring

Modification time

Example: "2023-06-13 09:34:39"

useYnstring

Availability(Y: Allowed, N: Not allowed)

Example: "Y"

Request

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

Response

[
  {
    "apiUrl": "https://0.0.0.0:0",
    "authType": "CERT",
    "clusterId": "thingcluster",
    "clusterName": "devops cluster",
    "clusterSeq": 1,
    "clusterState": "RUNNING",
    "created": "2022-12-16 08:16:50",
    "cubeType": "MANAGED",
    "description": "",
    "ingressSupported": "Y",
    "k8sVersion": "1.23.14",
    "loadbalancerSupported": "N",
    "nodePortRange": "30000-32767",
    "nodePortSupported": "Y",
    "nodePortUrl": "0.0.0.0",
    "persistentVolumeSupported": "Y",
    "providerAccountSeq": 1,
    "regionCode": "Default",
    "updated": "2023-06-13 09:34:39",
    "useYn": "Y"
  }
]

Get cluster details

Get the cluster details.

GET/v1/clusters/{clusterId}

Path parameters

clusterId*string

Response

Body

apiUrlstring

Example: "https://0.0.0.0:0"

authTypestring

authentication type(TOKEN, CERT, PLAIN)

Example: "CERT"

clusterIdstring

Example: "thingcluster"

clusterNamestring

Example: "devops cluster"

clusterSeqinteger

Example: 1

clusterStatestring

clusterState(RUNNING, STOPPED)

Example: "RUNNING"

countOfNamespaceinteger

Example: 22

countOfNodeinteger

Example: 7

countOfStaticVolumeinteger

Example: 0

countOfStorageClassinteger

Example: 2

countOfVolumeinteger

Example: 48

createdstring

Creation date/time

Example: "2022-12-16 08:16:50"

cubeTypestring

Cube cluster type(ECS, EKS, ACS, AKS, GKE, TKE, OCP, OKE, MANAGED, PROVIDER)

Example: "MANAGED"

descriptionstring

Example: ""

ingressSupportedstring

Ingress support availability(Y: Allowed, N: Not allowed)

Example: "Y"

k8sVersionstring

Example: "1.23.14"

loadbalancerSupportedstring

Load balancer support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortRangestring

Node port range(required if supporting node ports)

Example: "30000-32767"

nodePortSupportedstring

Node port support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortUrlstring

Example: "0.0.0.0"

persistentVolumeSupportedstring

Volume request support availability(Y: Allowed, N: Not allowed)

Example: "Y"

providerAccountProviderAccount (object)

descriptionstring

Example: ""

providerCodestring

Example: "IDC"

providerCodeNamestring

Example: "Datacenter"

providerNamestring

Example: "thingcluster"

seqinteger

Example: 1

useTypestring

Provider type(METERING, USER, ACCESS_KEY)

Example: "USER"

regionCodestring

Example: "KR"

updatedstring

Modification time

Example: "2023-06-13 09:34:39"

useYnstring

Availability(Y: Allowed, N: Not allowed)

Example: "Y"

Request

Response

Get cluster node events list

Return the cluster node event list.

GET/v1/clusters/{clusterId}/nodes/{nodeName}/event

Path parameters

clusterId*string

nodeName*string

Response

Body

countinteger

deploymentstring

Event deployment information

Example: ""

deploymentYamlstring

Event deployment information(YAML)

Example: ""

firstTimestring

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

involvedObjectInvolvedObject (object)

apiVersionstring

Example: ""

fieldPathstring

Example: ""

kindstring

Example: ""

namestring

Example: ""

namespacestring

namespace name

Example: "cocktail-system"

resourceVersionstring

Resource type

Example: ""

uidstring

UID

Example: ""

kindstring

Example: ""

lastTimestring

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

messagestring

Example: ""

namestring

Event name

Example: ""

namespacestring

namespace name

Example: "cocktail-system"

relatedRelated (object)

apiVersionstring

Example: ""

fieldPathstring

Example: ""

kindstring

Example: ""

namestring

Example: ""

namespacestring

namespace name

Example: "cocktail-system"

resourceVersionstring

Resource type

Example: ""

uidstring

UID

Example: ""

sourcestring

Example: ""

subObjectstring

Example: ""

Request

const response = await fetch('/v1/clusters/{clusterId}/nodes/{nodeName}/event', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "deployment": "",
    "deploymentYaml": "",
    "firstTime": "2023-04-29 05:54:51",
    "involvedObject": {
      "apiVersion": "",
      "fieldPath": "",
      "kind": "",
      "name": "",
      "namespace": "cocktail-system",
      "resourceVersion": "",
      "uid": ""
    },
    "kind": "",
    "lastTime": "2023-04-29 05:54:53",
    "message": "",
    "name": "",
    "namespace": "cocktail-system",
    "related": {
      "apiVersion": "",
      "fieldPath": "",
      "kind": "",
      "name": "",
      "namespace": "cocktail-system",
      "resourceVersion": "",
      "uid": ""
    },
    "source": "",
    "subObject": ""
  }
]

Get cluster storage details

Get the storage details of the cluster.

GET/v1/clusters/{clusterId}/storages/{storageName}

Path parameters

clusterId*string

storagesName*string

Response

Body

annotationsobject

additionalPropstring

baseStorageYnstring

Default storage availability (Y: Allowed, N: Not allowed)

Example: "Y"

descriptionstring

Example: ""

labesobject

additionalPropstring

mountOptionsarray of string

Mount options list

itemsstring

namestring

Storage name

Example: "nfs-csi"

parametersarray of object

Parameter list

namestring

Parameter name

valuestring

Parameter value

phasestring

Volume status(Only used in Static Volume)(UNKNOWN, AVAILABLE, BOUND, RELEASED, FAILED, DELETED)

Example: "AVAILABLE"

pluginstring

Example: "NFS_CSI"

provisionerNamestring

Example: "nfs.csi.k8s.io"

readOnlyManyYnstring

Volume request ReadOnlyMany support availability (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteManyYnstring

Volume request ReadWriteMany support availability (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteOnceYnstring

Volume request readWriteOnceYn support availability (Y: Allowed, N: Not allowed)

Example: "Y"

reclaimPolicystring

reclaimPolicy(RECYCLE, RETAIN, DELETE, RECYCLE, RETAIN, DELETE)

Example: "RETAIN"

storageClassStorageClass (object)

creationTimestampstring

Example: "2022-12-02 02:16:03"

deploymentstring

Deployment information

Example: "{\"apiVersion\":\"storage.k8s.io/v1\",\"kind\":\"StorageClass\"..."

deploymentYamlstring

Deployment information(YAML)

Example: "apiVersion: storage.k8s.io/v1\nkind: StorageClass\n..."

detailobject

Detailed information

additionalPropany

labesobject

additionalPropstring

namestring

Storage name

Example: "nfs-csi"

parametersarray of object

Parameter list

namestring

Parameter name

valuestring

Parameter value

provisionerstring

Provisioner

Example: "nfs.csi.k8s.io"

storageTypestring

storageType(BLOCK, NETWORK, BLOCK, NETWORK)

Example: "NETWORK"

totalCapacityinteger

Example: 1024

typestring

Configuration type(None, HOST_PATH, EMPTY_DIR, CONFIG_MAP, SECRET, PERSISTENT_VOLUME_STATIC, PERSISTENT_VOLUME_LINKED, PERSISTENT_VOLUME)

Example: "PERSISTENT_VOLUME"

volumeBindingModestring

volumeBindingMode(IMMEDIATE, WAIT_FOR_FIRST_CONSUMER, IMMEDIATE, WAIT_FOR_FIRST_CONSUMER)

Example: "IMMEDIATE"

Request

const response = await fetch('/v1/clusters/{clusterId}/storages/{storageName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "annotations": {
    "cocktail-user-description": "bmZzLWNzaQ==",
    "meta.helm.sh/release-name": "default-storage",
    "meta.helm.sh/release-namespace": "kube-system"
  },
  "baseStorageYn": "Y",
  "description": "",
  "labes": {
    "acornsoft.io/provisioner-type": "NFS_CSI",
    "acornsoft.io/total-capacity": "1024",
    "acornsoft.io/type": "NETWORK"
  },
  "mountOptions": [
    "hard",
    "nfsvers=4.1"
  ],
  "name": "nfs-csi",
  "parameters": [
    {
      "name": "server",
      "value": "0.0.0.0"
    }
  ],
  "phase": "AVAILABLE",
  "plugin": "NFS_CSI",
  "provisionerName": "nfs.csi.k8s.io",
  "readOnlyManyYn": "Y",
  "readWriteManyYn": "Y",
  "readWriteOnceYn": "Y",
  "reclaimPolicy": "RETAIN",
  "storageClass": {
    "creationTimestamp": "2022-12-02 02:16:03",
    "deployment": "{\"apiVersion\":\"storage.k8s.io/v1\",\"kind\":\"StorageClass\"...",
    "deploymentYaml": "apiVersion: storage.k8s.io/v1\nkind: StorageClass\n...",
    "detail": {
      "annotations": {
        "cocktail-user-description": "bmZzLWNzaQ==",
        "meta.helm.sh/release-name": "default-storage",
        "meta.helm.sh/release-namespace": "kube-system"
      },
      "creationTime": "2022-12-02 02:16:03",
      "labels": {
        "acornsoft.io/provisioner-type": "NFS_CSI",
        "acornsoft.io/total-capacity": "1024",
        "acornsoft.io/type": "NETWORK"
      },
      "mountOptions": [
        "hard",
        "nfsvers=4.1"
      ],
      "name": "nfs-csi",
      "parameters": {
        "server": "0.0.0.0",
        "share": "/thingcluster"
      },
      "provisioner": "nfs.csi.k8s.io",
      "reclaimPolicy": "Retain",
      "volumeBindingMode": "Immediate"
    },
    "labes": {
      "acornsoft.io/provisioner-type": "NFS_CSI",
      "acornsoft.io/total-capacity": "1024",
      "acornsoft.io/type": "NETWORK"
    },
    "name": "nfs-csi",
    "parameters": [
      {
        "name": "server",
        "value": "0.0.0.0"
      }
    ],
    "provisioner": "nfs.csi.k8s.io"
  },
  "storageType": "NETWORK",
  "totalCapacity": 1024,
  "type": "PERSISTENT_VOLUME",
  "volumeBindingMode": "IMMEDIATE"
}

Get cluster configuration list

Get the list of settings for that cluster.

GET/v1/clusters/{clusterId}/settings

Path parameters

clusterId*string

Response

Body

creationTimestampstring

Example: "2023-06-12 01:16:43"

namestring

Configuration information name

Example: "cocktail-api-cmdb"

namespaceNamestring

Example: "cocktail-system"

typestring

Configuration information type

Example: "ConfigMap"

Request

Response

Get cluster workloads list

Get the workload list for that cluster.

GET/v1/clusters/{clusterId}/workloads

Path parameters

clusterId*string

Response

Body

activeCountinteger

Example: 1

computeTotalinteger

Total number of computes

Example: 1

creationTimestampstring

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

descriptionstring

Example: ""

isK8sResourceExistboolean

namespaceNamestring

Example: "cocktail-system"

qosstring

QoS

Example: "Burstable"

stateCodestring

stateCode(RUNNING, STOPPED)

Example: "RUNNING"

workloadGroupSeqinteger

Example: 11

workloadNamestring

Example: "cocktail-api-cmdb"

workloadTypestring

Example: "STATEFUL_SET_SERVER"

Request

Response

Get cluster service exposures list

Get the list of service exposures for that cluster.

GET/v1/clusters/{clusterId}/services

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

clusterIPstring

Example: "0.0.0.0"

creationTimestampstring

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

internalLBFlagboolean

Internal load balancer availability

Example: false

labelsobject

additionalPropstring

namespacestring

namespace name

Example: "cocktail-system"

serviceNamestring

Example: "api-cmd"

servicePortsarray of ServicePorts (object)

Port list

portstring

Example: "0"

protocolstring

Example: "TCP"

serviceUrlstring

Example: "0.0.0.0:0"

targetPortstring

Example: "0"

sessionAffinitystring

Session Affinity

Example: "None"

typestring

Service type(ClusterIP, NodePort)

Example: "ClusterIP"

Request

Response

Get cluster node details

Return the cluster node event list.

GET/v1/clusters/{clusterId}/nodes/{nodeName}

Path parameters

clusterId*string

nodeName*string

Response

Body

allocatableAllocatable (object)

additionalPropobject

formatstring

DECIMAL_EXPONENT or DECIMAL_SI or BINARY_SI

numberinteger

capacityCapacity (object)

additionalPropobject

formatstring

DECIMAL_EXPONENT or DECIMAL_SI or BINARY_SI

numberinteger

conditionsarray of Conditions (object)

Node status information

lastHeartbeatTimestring

Last measurement time

Example: "2023-06-12 01:18:50"

lastTransitionTimestring

Example: "2023-06-12 01:18:50"

messagestring

Example: "Cilium is running on this node"

reasonstring

Example: "CalicoIsUp"

statusstring

status(True or False)

Example: "False"

typestring

Example: "NetworkUnavailable"

creationTimestampstring

Example: "2023-06-12 01:17:47"

detailDetail (object)

addressesobject

Allowed addresses on the node

annotationsobject

additionalPropstring

architecturestring

Example: "amd64"

bootIDstring

Example: "36955d45-9257-4ef8-815a-c3e2b142180e"

containerRuntimeVersionstring

Example: "containerd://1.6.10"

creationTimestring

Example: "2022-12-02 02:33:48"

kernelVersionstring

Example: "3.10.0-1160.24.1.el7.x86_64"

kubeProxyVersionstring

Example: "v1.23.14"

kubeletVersionstring

Example: "v1.23.14"

labelsobject

additionalPropstring

machineIDstring

Example: "14b02ba119194cb3980cd859ae208204"

namestring

node name

Example: "apps-gpu-v100"

operatingSystemstring

Example: "linux"

osImagestring

Example: "CentOS Linux 7 (Core)"

podCIDRstring

Pod IP range allocated to the node

Example: "0.0.0.0/0"

systemUUIDstring

Example: "4C4C4544-004A-4E10-8032-B4C04F383233"

unschedulableboolean

Node scheduling for new pods(nodes are schedulable by default)

Example: "false"

labelsobject

additionalPropstring

namestring

Example: "apps-gpu-v100"

readystring

ready(True or False)

Example: "True"

Request

const response = await fetch('/v1/clusters/{clusterId}/nodes/{nodeName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "allocatable": {
    "additionalProp": {
      "format": "text"
    }
  },
  "capacity": {
    "additionalProp": {
      "format": "text"
    }
  },
  "conditions": [
    {
      "lastHeartbeatTime": "2023-06-12 01:18:50",
      "lastTransitionTime": "2023-06-12 01:18:50",
      "message": "Cilium is running on this node",
      "reason": "CalicoIsUp",
      "status": "False",
      "type": "NetworkUnavailable"
    }
  ],
  "creationTimestamp": "2023-06-12 01:17:47",
  "detail": {
    "addresses": {
      "Hostname": "apps-gpu-v100",
      "InternalIP": "0.0.0.0"
    },
    "annotations": {
      "csi.volume.kubernetes.io/nodeid": "{\"nfs.csi.k8s.io\":\"apps-gpu-v100\"}",
      "kubeadm.alpha.kubernetes.io/cri-socket": "unix:///run/containerd/containerd.sock",
      "nfd.node.kubernetes.io/extended-resources": ""
    },
    "architecture": "amd64",
    "bootID": "36955d45-9257-4ef8-815a-c3e2b142180e",
    "containerRuntimeVersion": "containerd://1.6.10",
    "creationTime": "2022-12-02 02:33:48",
    "kernelVersion": "3.10.0-1160.24.1.el7.x86_64",
    "kubeProxyVersion": "v1.23.14",
    "kubeletVersion": "v1.23.14",
    "labels": {
      "beta.kubernetes.io/arch": "amd64",
      "beta.kubernetes.io/os": "linux",
      "cube.acornsoft.io/clusterid": "cube"
    },
    "machineID": "14b02ba119194cb3980cd859ae208204",
    "name": "apps-gpu-v100",
    "operatingSystem": "linux",
    "osImage": "CentOS Linux 7 (Core)",
    "podCIDR": "0.0.0.0/0",
    "systemUUID": "4C4C4544-004A-4E10-8032-B4C04F383233",
    "unschedulable": "false"
  },
  "labels": {
    "beta.kubernetes.io/arch": "amd64",
    "beta.kubernetes.io/os": "linux",
    "cube.acornsoft.io/clusterid": "cube"
  },
  "name": "apps-gpu-v100",
  "ready": "True"
}

Get cluster nodes list

Get the list of cluster nodes.

GET/v1/clusters/{clusterId}/nodes

Path parameters

clusterId*string

Response

Body

allocatedCpuinteger

Allocated CPU capacity

Example: 48

allocatedEphemeralStorageinteger

Allocated Ephemeral Storage Capacity

Example: 0

allocatedMemoryinteger

Allocated memory capacity

Example: 200903610368

allocatedPodsstring

Allocated number of pods

Example: "110"

cpuCapacityinteger

Example: 48

creationTimestampstring

Example: "2022-12-02 02:33:48"

ephemeralStorageCapacityinteger

Example: 48294789041

gpuCapacityinteger

Example: 2

memoryCapacityinteger

Example: 201008467968

namestring

node name

Example: "apps-gpu-v100"

podCapacityinteger

Example: 110

readystring

ready(True or False)

Example: "True"

Request

Response

Get clusters status list

Get the status of all clusters.

GET/v1/clusters/conditions

Response

Body

accountAccount (object)

accountCodestring

Example: "DEVOPS"

accountNamestring

Example: "DEVOPS"

accountSeqinteger

Example: 1

accountTypestring

accountType(CCO, ENT, OEM, APP, CBE)

Example: "ENT"

baseLanguagestring

baseLanguage(ko, en, ja, zh)

Example: "ko"

concurrentSessionYnstring

Allow concurrent sessions(Y: Allowed, N: Not allowed)

Example: "Y"

descriptionstring

Example: ""

organizationNameinteger

Account organization name

Example: "DEVOPS"

userAuthTypestring

User authentication type(PLAIN, AAD, AD)

Example: "PLAIN"

apiUrlstring

Example: "https://0.0.0.0:0"

authTypestring

authType(TOKEN, CERT, PLAIN)

Example: "CERT"

clusterIdstring

Example: "thingcluster"

clusterNamestring

Example: "devops cluster"

clusterSeqinteger

Example: 1

clusterStatestring

clusterState(RUNNING, STOPPED)

Example: "RUNNING"

createdstring

Creation date/time

Example: "2022-12-16 08:16:50"

cubeTypestring

cube ClusterType(ECS, EKS, ACS, AKS, GKE, TKE, OCP, OKE, MANAGED, PROVIDER)

Example: "MANAGED"

descriptionstring

Example: ""

ingressSupportedstring

Ingress support availability(Y: Allowed, N: Not allowed)

Example: "Y"

k8sVersionstring

Example: "1.23.14"

loadbalancerSupportedstring

Load balancer support availability(Y: Allowed, N: Not allowed)

Example: "N"

nodePortRangestring

Node port range(required if supporting node ports)

Example: "30000-32767"

nodePortSupportedstring

Node port support availability(Y: Allowed, N: Not allowed)

Example: "Y"

nodePortUrlstring

Example: "0.0.0.0"

persistentVolumeSupportedstring

Volume request support availability(Y: Allowed, N: Not allowed)

Example: "Y"

providerAccountProviderAccount (object)

descriptionstring

Example: ""

providerCodestring

Example: "IDC"

providerCodeNamestring

Example: "Datacenter"

providerNamestring

Example: "thingcluster"

seqinteger

Example: 1

useTypestring

Provider type(METERING, USER, ACCESS_KEY)

Example: "USER"

regionCodestring

Example: "Default"

updatedstring

Modification time

Example: "2023-06-13 09:34:39"

useYnstring

Availability (Y: Allowed, N: Not allowed)

Example: "Y"

Request

Response

[
  {
    "account": {
      "accountCode": "DEVOPS",
      "accountName": "DEVOPS",
      "accountSeq": 1,
      "accountType": "ENT",
      "baseLanguage": "ko",
      "concurrentSessionYn": "Y",
      "description": "",
      "organizationName": "DEVOPS",
      "userAuthType": "PLAIN"
    },
    "apiUrl": "https://0.0.0.0:0",
    "authType": "CERT",
    "clusterId": "thingcluster",
    "clusterName": "devops cluster",
    "clusterSeq": 1,
    "clusterState": "RUNNING",
    "created": "2022-12-16 08:16:50",
    "cubeType": "MANAGED",
    "description": "",
    "ingressSupported": "Y",
    "k8sVersion": "1.23.14",
    "loadbalancerSupported": "N",
    "nodePortRange": "30000-32767",
    "nodePortSupported": "Y",
    "nodePortUrl": "0.0.0.0",
    "persistentVolumeSupported": "Y",
    "providerAccount": {
      "description": "",
      "providerCode": "IDC",
      "providerCodeName": "Datacenter",
      "providerName": "thingcluster",
      "seq": 1,
      "useType": "USER"
    },
    "regionCode": "Default",
    "updated": "2023-06-13 09:34:39",
    "useYn": "Y"
  }
]

Get cluster addon list

Get the list of Addons for that cluster.

GET/v1/clusters/{clusterId}/addons

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2023-06-20 04:08:00"

dataData (object)

additionalPropstring

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

ConfigMap name

Example: "addon-manager"

namespacestring

namespace name

Example: "cocktail-addon"

Request

Response

Get cluster namespace details

Get the namespace details of the cluster.

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

Path parameters

clusterId*string

namespaceName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2022-12-02 06:21:35"

deploymentstring

Deployment information

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

deploymentYamlstring

Deployment information(YAML)

Example: "apiVersion: v1\nkind: Node\nmetadata..."

detailDetail (object)

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2022-12-02 06:21:35"

labelsobject

additionalPropstring

namestring

Namespace name

Example: "cocktail-system"

statusstring

Example: "Active"

labelsobject

additionalPropstring

namestring

Namespace name

Example: "cocktail-system"

statusstring

Example: "Active"

Request

Response

Get cluster pods list

Get the list of the cluster.

GET/v1/clusters/{clusterId}/pods

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

labesobject

additionalPropstring

namespacestring

namespace name

Example: "cocktail-system"

nodeNamestring

Example: "apps-gpu-v100"

podNamestring

Example: "cocktail-api-cmdb-0"

podStatusstring

podStatus(RUNNING, STOPPED)

Example: "Running"

restartCntinteger

Example: 0

startTimestring

Example: "2023-05-01 09:20:09"

Request

Response

Get cluster namespace ingress details

Get detailed information for the Ingress in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/ingresses/{ingressName}

Path parameters

clusterId*string

namespaceName*string

ingressName*string

Response

Body

creationTimestampstring

Example: "2023-06-15 07:52:17"

deploymentstring

Deployment information

Example: "{\"apiVersion\":\"networking.k8s.io/v1\"..."

deploymentYamlstring

Deployment information(YAML)

Example: "apiVersion: v1\nkind: Node\nmetadata..."

detailDetail (object)

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2023-01-12 08:33:06"

labelsobject

additionalPropstring

namestring

Ingress name

Example: "api"

namespacestring

namespace name

Example: "cocktail-system"

endpointsarray of string

Endpoint list

itemsstring

Example: "0.0.0.0"

ingressSpecIngressSpec (object)

annotationsobject

additionalPropstring

ingressControllerNamestring

Example: "nginx"

labelsobject

additionalPropstring

namestring

Ingress name

Example: "api"

namespaceNamestring

namespace name

Example: "cocktail-system"

rulesarray of object

Policy rule

additionalPropany

tlsarray of object

Ingress TLS

additionalPropany

useSslRedirectboolean

SSL Redirect enabled

Example: false

namestring

Ingress name

Example: "api"

namespacestring

namespace name

Example: "cocktail-system"

Request

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

Response

{
  "creationTimestamp": "2023-06-15 07:52:17",
  "deployment": "{\"apiVersion\":\"networking.k8s.io/v1\"...",
  "deploymentYaml": "apiVersion: v1\nkind: Node\nmetadata...",
  "detail": {
    "annotations": {
      "nginx.ingress.kubernetes.io/ssl-redirect": "false"
    },
    "creationTimestamp": "2023-01-12 08:33:06",
    "labels": {
      "app": "api"
    },
    "name": "api",
    "namespace": "cocktail-system"
  },
  "endpoints": [
    "0.0.0.0"
  ],
  "ingressSpec": {
    "annotations": {
      "nginx.ingress.kubernetes.io/ssl-redirect": "false"
    },
    "ingressControllerName": "nginx",
    "labels": {
      "app": "api"
    },
    "name": "api",
    "namespaceName": "cocktail-system",
    "rules": [
      {
        "host": {
          "type": "string",
          "example": "devops-api.acloud.run"
        },
        "paths": {
          "type": "array",
          "description": "<p>Path list</p>",
          "items": {
            "type": "object",
            "example": {
              "path": "/v1",
              "pathType": "ImplementationSpecific",
              "serviceName": "api-gateway",
              "servicePort": "8081",
              "servicePortIsInteger": true
            }
          },
          "__$markdownParsed": true
        }
      }
    ],
    "tls": [
      {
        "hosts": [
          "devops-api.acloud.run"
        ],
        "secretName": "acloudrun-tls"
      }
    ],
    "useSslRedirect": false
  },
  "name": "api",
  "namespace": "cocktail-system"
}

Get cluster PVC list

Get the list of volume request list of the cluster.

GET/v1/clusters/{clusterId}/persistentvolumeclaims

Path parameters

clusterId*string

Response

Body

accessModesarray of string

Access mode list

itemsstring

Example: "ReadWriteOnce"

annotationsobject

additionalPropstring

capacityobject

additionalPropstring

creationTimestampstring

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

labelsobject

additionalPropstring

namestring

PVC name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

persistentVolumeTypestring

PVC Type(SINGLE, SHARED)

Example: "SHARED"

statusstring

PVC status

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

Request

Response

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"
}

Get cluster namespace configmap details

Get detailed information for the ConfigMap in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/configmaps/{configmapName}

Path parameters

clusterId*string

namespaceName*string

configmapName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

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

dataData (object)

additionalPropstring

deploymentstring

deployment information

Example: "{\"apiVersion\":\"v1\",\"data\":{\"my.cnf\":\"[client]..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: v1\nkind: ConfigMap\nmetadata..."

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

configmap name

Example: "cocktail-api-cmdb"

namespacestring

네namespace name

Example: "cocktail-system"

Request

Response

Get cluster namespace PVC list

Get cluster namespace PVC details.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/persistentvolumeclaims

Path parameters

clusterId*string

namespaceName*string

Response

Body

accessModesarray of string

access Mode list

itemsstring

Example: "ReadWriteMany"

capacityobject

additionalPropstring

creationTimestampstring

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

namestring

PVC name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

persistentVolumeTypestring

PVC type(SINGLE, SHARED)

Example: "SHARED"

statusstring

PVC tatus

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

Request

Response

Get cluster namespace PVC details

Get detailed information for PVC in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/persistentvolumeclaims/{pvcName}

Path parameters

clusterId*string

namespaceName*string

pvcName*string

Response

Body

accessModesarray of string

access Mode lis

itemsstring

Example: "ReadWriteMany"

capacityobject

additionalPropstring

clusterVolumeClusterVolume (object)

annotationsobject

additionalPropstring

baseStorageYnstring

Default storage availability (Y: Allowed, N: Not allowed)

Example: "Y"

descriptionstring

Example: ""

labelsobject

additionalPropstring

mountOptionsarray of string

Cluster volume mount options list

itemsstring

namestring

PVC name

Example: "nfs-csi"

parametersarray of object

Parameter list

namestring

Parameter name

valuestring

Parameter value

phasestring

Volume status (Only used in Static Volume)(UNKNOWN, AVAILABLE, BOUND, RELEASED, FAILED, DELETED)

Example: "AVAILABLE"

pluginstring

Example: "NFS_CSI"

provisionerNamestring

Example: "nfs.csi.k8s.io"

readOnlyManyYnstring

Support for ReadOnlyMany volume requests (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteManyYnstring

Support for ReadWriteMany volume requests (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteOnceYnstring

Support for readWriteOnceYn volume requests (Y: Allowed, N: Not allowed)

Example: "Y"

reclaimPolicystring

reclaimPolicy(RECYCLE, RETAIN, DELETE, RECYCLE, RETAIN, DELETE)

Example: "RETAIN"

storageTypestring

storage Type(NETWORK, BLOCK)

Example: "NETWORK"

totalCapacityinteger

Example: 1024

typestring

type(PERSISTENT_VOLUME, PERSISTENT_VOLUME_STATIC)

Example: "PERSISTENT_VOLUME"

volumeBindingModestring

volumeBindingMode(IMMEDIATE, WAIT_FOR_FIRST_CONSUMER, IMMEDIATE, WAIT_FOR_FIRST_CONSUMER)

Example: "IMMEDIATE"

creationTimestampstring

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

deploymentstring

deployment information

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

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:..."

detailDetail (object)

accessModesarray of string

access Mode list

itemsstring

Example: "ReadWriteMany"

annotationsobject

additionalPropstring

capacityobject

additionalPropstring

creationTimestampstring

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

labelsobject

additionalPropstring

namestring

Persistent Volume name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

namestring

Persistent Volume name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

persistentVolumePersistentVolume (object)

accessModesarray of string

access Mode list

itemsstring

Example: "ReadWriteMany"

capacityobject

additionalPropstring

claimNamestring

PVC name

Example: "cocktail-api-cmdb-logdata"

claimNameWithNamespacestring

PVC name with namespace

Example: "cocktail-system/cocktail-api-cmdb-logdata"

creationTimestampstring

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

deploymentstring

deployment information

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

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: v1\nkind: PersistentVolume\nmetadata..."

detailobject

Detailed information

additionalPropany

namestring

Volume name

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

persistentVolumeReclaimPolicystring

Reclaim policy name

Example: "Retain"

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

persistentVolumeTypestring

Persistent Volume type(SINGLE, SHARED)

Example: "SHARED"

serverParamsarray of ServerParams (object)

Server parameter information

containerVolumesarray of object

Container volume information

additionalPropany

namespaceNamestring

Example: "cocktail-system"

serverNamestring

Example: "cocktail-api-cmdb"

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

Request

Response

Get cluster namespace ingress list

Get the list of Ingresses in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/ingresses

Path parameters

clusterId*string

namespaceName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2023-01-12 08:33:06"

endpointsarray of string

Endpoint list

itemsstring

ingressControllerNamestring

Example: "nginx"

labelsobject

additionalPropstring

namestring

Ingress name

Example: "api"

namespacestring

Namespace name

Example: "cocktail-system"

Request

Response

Get cluster namespace secret list

Get the list of Secrets in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/secrets

Path parameters

clusterId*string

namespaceName*string

Response

Body

creationTimestampstring

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

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

Secret name

Example: "cocktail-api-cmdb"

namespacestring

namespace name

Example: "cocktail-system"

typestring

Secret type(Generic, DockerRegistry, Tls, BasicAuth, SshAuth)

Example: "Generic"

Request

Response

Get cluster namespace DaemonSet details

Get detailed information for DaemonSet in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/daemonsets/{daemonSetName}

Path parameters

clusterId*string

namespaceName*string

daemonSetName*string

Response

Body

creationTimestampstring

Example: "2023-06-21 06:41:56"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"apps/v1\",\"kind\":\"DaemonSet\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: apps/v1\nkind: DaemonSet\nmetadata:\n..."

desiredPodCntinteger

Number of pods to provide

Example: 7

detailDetail (object)

annotationsobject

additionalPropstring

creationTimestring

Example: "2023-06-21 06:41:56"

labelsobject

additionalPropstring

minReadySecondsinteger

Minimum time to be ready

Example: 0

namestring

DaemonSet name

Example: "promtail"

namespacestring

namespace name

Example: "cocktail-system"

podTemplateobject

additionalPropany

revisionHistoryLimitstring

Number of previous replicaset to maintain

Example: "10"

rollingUpdateobject

Rolling update related information

additionalPropstring

selectorobject

State-related information

additionalPropstring

statusobject

State-related information

additionalPropstring

strategyobject

update Strategy type

Example: "RollingUpdate"

imagesarray of string

Image list

itemsstring

Example: "101.55.69.30/docker.io/grafana/promtail:2.7.4"

labelsobject

additionalPropstring

namestring

DaemonSet name

Example: "promtail"

namespacestring

namespace name

Example: "cocktail-system"

readyPodCntinteger

Number of ready pods

Example: 7

Request

Response

Get cluster namespace Deployments list

Get the list of Deployments in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/deployments

Path parameters

clusterId*string

namespaceName*string

Response

Body

conditionsarray of Conditions (object)

status information

lastHeartbeatTimestring

Last measurement time

Example: "2023-05-02 07:12:02"

lastTransitionTimestring

Example: "2023-05-02 07:12:02"

messagestring

Example: "Deployment has minimum availability."

reasonstring

Example: "MinimumReplicasAvailable"

statusstring

status(True or False)

Example: "True"

typestring

Example: "Available"

creationTimestampstring

Example: "2023-05-02 07:12:02"

desiredPodCntinteger

Number of pods to provide

Example: 1

imagesarray of string

Image list

itemsstring

Example: "regi.acloud.run/library/log-api:1.3.0"

labelsobject

additionalPropstring

matchLabelsobject

match label list

additionalPropstring

namestring

Deployement name

Example: "cocktail-log-api"

namespacestring

namespace name

Example: "cocktail-system"

readyPodCntinteger

Number of ready pods

Example: 1

Request

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

Response

[
  {
    "conditions": [
      {
        "lastHeartbeatTime": "2023-05-02 07:12:02",
        "lastTransitionTime": "2023-05-02 07:12:02",
        "message": "Deployment has minimum availability.",
        "reason": "MinimumReplicasAvailable",
        "status": "True",
        "type": "Available"
      }
    ],
    "creationTimestamp": "2023-05-02 07:12:02",
    "desiredPodCnt": 1,
    "images": [
      "regi.acloud.run/library/log-api:1.3.0"
    ],
    "labels": {
      "app": "api",
      "app.kubernetes.io/managed-by": "Helm",
      "chart": "api-1.0.0"
    },
    "matchLabels": {
      "app.kubernetes.io/app": "cocktail-log-api",
      "app.kubernetes.io/instance": "cocktail-log",
      "app.kubernetes.io/name": "api"
    },
    "name": "cocktail-log-api",
    "namespace": "cocktail-system",
    "readyPodCnt": 1
  }
]

Get cluster namespace secret details

Get detailed information for the Secret in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/secrets/{secretName}

Path parameters

clusterId*string

namespaceName*string

secretName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

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

dataData (object)

additionalPropstring

deploymentstring

Deployment informatio

Example: "{\"apiVersion\":\"v1\",\"data\"..."

deploymentYamlstring

Deployment informatio(YAML)

Example: "apiVersion: v1\nkind: Secret\nmetadata:\n..."

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

Secret name

Example: "cocktail-api-cmdb"

namespacestring

namespace name

Example: "cocktail-system"

typestring

Secret type(Generic, DockerRegistry, Tls, BasicAuth, SshAuth)

Example: "Generic"

Request

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

Response

{
  "annotations": {
    "meta.helm.sh/release-name": "cocktail",
    "meta.helm.sh/release-namespace": "cocktail-system"
  },
  "creationTimestamp": "2023-04-29 05:54:51",
  "data": {
    "additionalProp": "text"
  },
  "deployment": "{\"apiVersion\":\"v1\",\"data\"...",
  "deploymentYaml": "apiVersion: v1\nkind: Secret\nmetadata:\n...",
  "description": "",
  "labels": {
    "app.kubernetes.io/instance": "cocktail",
    "app.kubernetes.io/managed-by": "Helm",
    "app.kubernetes.io/name": "api-cmdb"
  },
  "name": "cocktail-api-cmdb",
  "namespace": "cocktail-system",
  "type": "Generic"
}

Get cluster namespace configmap list

Get the list of ConfigMaps in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/configmaps

Path parameters

clusterId*string

namespaceName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

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

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

configmap name

Example: "cocktail-api-cmdb"

namespacestring

namespace name

Example: "cocktail-system"

Request

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

Response

[
  {
    "annotations": {
      "meta.helm.sh/release-name": "cocktail",
      "meta.helm.sh/release-namespace": "cocktail-system"
    },
    "creationTimestamp": "2023-04-29 05:54:51",
    "description": "",
    "labels": {
      "app.kubernetes.io/instance": "cocktail",
      "app.kubernetes.io/managed-by": "Helm",
      "app.kubernetes.io/name": "api-cmdb"
    },
    "name": "cocktail-api-cmdb",
    "namespace": "cocktail-system"
  }
]

Get cluster ingress list

Get the ingress list of the cluster.

GET/v1/clusters/{clusterId}/ingresses

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2023-01-12 08:33:06"

endpointsarray of string

Endpoint list

itemsstring

ingressControllerNamestring

Example: "nginx"

labesobject

additionalPropstring

namestring

ingress name

Example: "api"

namespacestring

namespace name

Example: "cocktail-system"

Request

Response

Get cluster CRD list

Get the CRD list of the cluster.

GET/v1/clusters/{clusterId}/crds

Path parameters

clusterId*string

Response

Body

acceptedNamesAcceptedNames (object)

categoriesarray of string

카테고리 목록 : 사용자 지정 리소스가 속한 그룹화된 리소스 목록

itemsstring

kindstring

리소스 종류(직렬화)

Example: "Gateway"

listKindstring

리소스에 대한 일련의 목록

Example: "GatewayList"

pluralstring

서비스할 리소스의 plural 이름

Example: "gateways"

shortNamesarray of string

리소스의 짧은 이름(모두 소문자)

itemsstring

Example: "gw"

singularstring

리소스의 singular 이름(모두 소문자)

Example: "gateway"

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2022-12-02 08:42:46"

fullNamestring

Example: "gateways.networking.istio.io"

groupstring

group name

Example: "networking.istio.io"

labesobject

additionalPropstring

namestring

resource name

Example: "gateways"

scopestring

resource scope(Cluster, Namespaced)

Example: "Namespaced"

storedVersionstring

Example: "v1alpha3"

versionsarray of object

Version list

namestring

Version name

Example: "v1alpha3"

servedboolean

Availability of the version

storageboolean

Whether to use the version when maintaining user resources in storage

Request

Response

Get cluster namespace DaemonSets list

Get the list of DaemonSets in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/daemonsets

Path parameters

clusterId*string

namespaceName*string

Response

Body

creationTimestampstring

Example: "2023-06-21 06:41:56"

desiredPodCntinteger

Number of pods to provide

Example: 7

imagesarray of string

image list

itemsstring

Example: "101.55.69.30/docker.io/grafana/promtail:2.7.4"

labelsobject

additionalPropstring

namestring

DaemonSet name

Example: "promtail"

namespacestring

namespace name

Example: "cocktail-system"

readyPodCntinteger

Number of ready pods

Example: 7

Request

Response

Get cluster namespace Cronjobs list

Get the list of CronJobs in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/cronjobs

Path parameters

clusterId*string

namespaceName*string

Response

Body

activeJobCntinteger

active job count

Example: 1

creationTimestampstring

Example: "2023-06-14 09:30:39"

imagesarray of string

Image list

itemsstring

Example: "nginx:latest"

labelsobject

additionalPropstring

lastScheduleTimestring

Example: "2023-06-14 09:31:00"

namestring

CronJob name

Example: "cronjob"

namespacestring

namespace name

Example: "cocktail-system"

schedulestring

Example: "* * * * *"

suspendboolean

Example: false

Request

Response

Get cluster namespace Job details

Get detailed information for Job in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/jobs/{jobName}

Path parameters

clusterId*string

namespaceName*string

jobName*string

Response

Body

completionPodCntinteger

완료된 파드 수

Example: 1

creationTimestampstring

생성 일시

Example: "2023-05-15 09:45:06"

deploymentstring

배포 정보

Example: "{\"apiVersion\":\"batch/v1\",\"kind\":\"Job\"..."

deploymentYamlstring

배포 정보(YAML)

Example: "apiVersion: batch/v1\nkind: Job\nmetadata:\n..."

desiredPodCntinteger

제공할 파드 수

Example: 1

detailDetail (object)

annotationsobject

어노테이션

additionalPropstring

backoffLimitinteger

job이 실패할 경우 재시작을 시도 횟수

Example: 3

completionsinteger

완료 개수

Example: 1

creationTimestring

생성 일시

Example: "2023-05-15 09:45:06"

labelsobject

라벨

additionalPropstring

namestring

Job 이름

Example: "cocktail-system-crd-upgrader-job-k8ssandra"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

parallelisminteger

parallelism

Example: 1

podTemplateobject

파드 템플릿

additionalPropany

selectorobject

상태 관련 정보

additionalPropstring

statusobject

상태 관련 정보

additionalPropstring

imagesarray of string

이미지 목록

itemsstring

Example: "docker.io/k8ssandra/k8ssandra-tools:latest"

labelsobject

라벨

additionalPropstring

namestring

Job 이름

Example: "cocktail-system-crd-upgrader-job-k8ssandra"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

Request

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

Response

[
  {
    "completionPodCnt": 1,
    "creationTimestamp": "2023-05-15 09:45:06",
    "deployment": "{\"apiVersion\":\"batch/v1\",\"kind\":\"Job\"...",
    "deploymentYaml": "apiVersion: batch/v1\nkind: Job\nmetadata:\n...",
    "desiredPodCnt": 1,
    "detail": {
      "annotations": {
        "helm.sh/hook": "pre-upgrade",
        "helm.sh/hook-delete-policy": "before-hook-creation",
        "helm.sh/hook-weight": "10"
      },
      "backoffLimit": 3,
      "completions": 1,
      "creationTime": "2023-05-15 09:45:06",
      "labels": {
        "app.kubernetes.io/instance": "cocktail-system",
        "app.kubernetes.io/managed-by": "Helm",
        "app.kubernetes.io/name": "cocktail-system"
      },
      "name": "cocktail-system-crd-upgrader-job-k8ssandra",
      "namespace": "cocktail-system",
      "parallelism": 1,
      "podTemplate": {
        "labels": {
          "app.kubernetes.io/instance": "cocktail-system",
          "app.kubernetes.io/managed-by": "Helm",
          "app.kubernetes.io/name": "cocktail-system",
          "app.kubernetes.io/part-of": "k8ssandra-cocktail-system-cocktail-system",
          "controller-uid": "60ccf04f-8999-474e-a38b-61633fcbaa39",
          "helm.sh/chart": "cocktail-system-1.6.1",
          "job-name": "cocktail-system-crd-upgrader-job-k8ssandra"
        },
        "spec": {
          "conditions": [],
          "cpuUsage": 0,
          "detail": {
            "containers": [
              {
                "args": [
                  "-upgradecrds",
                  "--targetVersion",
                  "1.6.1",
                  "--chartName",
                  "cocktail-system"
                ],
                "environmentVariables": {
                  "POD_NAMESPACE": "{\"apiVersion\":\"v1\",\"fieldPath\":\"metadata.namespace\"}"
                },
                "image": "docker.io/k8ssandra/k8ssandra-tools:latest",
                "imagePullPolicy": "IfNotPresent",
                "name": "crd-upgrade-job-k8ssandra",
                "resources": {},
                "restartCount": 0
              }
            ],
            "initContainers": [],
            "restartPolicy": "OnFailure",
            "serviceAccountName": "cocktail-system-crd-upgrader-k8ssandra",
            "terminationGracePeriodSeconds": 30
          },
          "memUsage": 0,
          "podStatus": "Pending",
          "restartCnt": 0
        }
      },
      "selector": {
        "matchLabels": {
          "controller-uid": "60ccf04f-8999-474e-a38b-61633fcbaa39"
        }
      },
      "status": {
        "Failed": 0,
        "Running": 0,
        "Succeeded": 1
      }
    },
    "images": [
      "docker.io/k8ssandra/k8ssandra-tools:latest"
    ],
    "labels": {
      "app.kubernetes.io/instance": "cocktail-system",
      "app.kubernetes.io/managed-by": "Helm",
      "app.kubernetes.io/name": "cocktail-system"
    },
    "name": "cocktail-system-crd-upgrader-job-k8ssandra",
    "namespace": "cocktail-system"
  }
]

Get cluster namespace ReplicaSets list

Get the list of ReplicaSets in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/replicaset

Path parameters

clusterId*string

namespaceName*string

Response

Body

creationTimestampstring

생성 일시

Example: "2023-06-28 08:10:52"

desiredPodCntinteger

제공할 파드 수

Example: 1

imagesarray of string

이미지 목록

itemsstring

Example: "regi.acloud.run/library/log-api:1.3.0"

labelsobject

라벨

additionalPropstring

namestring

ReplicaSet 이름

Example: "cocktail-log-api-9d5bcff4"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

ownerReferencesarray of OwnerReferences (object)

소유자 참조 목록

apiVersionstring

API 버전

Example: "apps/v1"

blockOwnerDeletionboolean

소유자 오브젝트 삭제 차단 여부

controllerboolean

컨트롤러 사용 여부

kindstring

유형

Example: "Deployment"

namestring

ReplicaSet 이름

Example: "cocktail-log-api"

uidstring

uid

Example: "85f52a56-52e7-4289-8777-25f8c78d60e5"

readyPodCntinteger

준비된 파드 수

Example: 1

Request

Response

Get cluster namespace Cronjob details

Get detailed information for CronJob in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/cronjobs/{cronJobName}

Path parameters

clusterId*string

namespaceName*string

cronJobName*string

Response

Body

activeJobCntinteger

active job count

Example: 1

creationTimestampstring

Example: "2023-06-14 09:30:39"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"batch/v1\",\"kind\":\"CronJob\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: batch/v1\nkind: CronJob\nmetadata:\n..."

detailDetail (object)

activeJobsarray of object

active job count

additionalPropany

annotationsobject

additionalPropstring

backoffLimitinteger

Number of retry attempts if the job fails

Example: 3

completionsinteger

Completion count

Example: 1

concurrencyPolicystring

Concurrency polic(Allow, Forbid, Replace)

Example: "Allow"

creationTimestampstring

Example: "2023-06-14 09:30:39"

failedJobsHistoryLimitinteger

Number of job failure records

Example: 1

labelsobject

additionalPropstring

lastScheduleTimestring

Example: "2023-07-04 06:38:00"

namestring

CronJob name

Example: "cronjob"

namespacestring

namespace name

Example: "cocktail-system"

parallelisminteger

parallelism

Example: 1

podTemplateobject

additionalPropany

schedulestring

Example: "* * * * *"

successfulJobsHistoryLimitinteger

Specify the number of successful job records

Example: 3

suspendboolean

Example: false

imagesarray of string

Image list

itemsstring

Example: "nginx:latest"

labelsobject

additionalPropstring

lastScheduleTimestring

Example: "2023-07-04 06:38:00"

namestring

CronJob name

Example: "cronjob"

namespacestring

namespace name

Example: "cocktail-system"

schedulestring

Example: "* * * * *"

suspendboolean

Example: false

Request

Response

Get cluster namespace StatefulSets list

Get the list of StatefulSets in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/statefulsets

Path parameters

clusterId*string

namespaceName*string

Response

Body

creationTimestampstring

생성 일시

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

desiredPodCntinteger

제공할 파드 수

Example: 1

imagesarray of string

이미지 목록

itemsstring

Example: "101.55.69.30/library/api-cmdb:4.7.4-release.20230413"

labelsobject

라벨

additionalPropstring

namestring

StatefulSet 이름

Example: "cocktail-api-cmdb"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

readyPodCntinteger

준비된 파드 수

Example: 1

Request

Response

Get cluster namespace StatefulSet details

Get detailed information for StatefulSet in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/statefulsets/{statefulSetName}

Path parameters

clusterId*string

namespaceName*string

statefulSetName*string

Response

Body

creationTimestampstring

생성 일시

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

deploymentstring

배포 정보

Example: "{\"apiVersion\":\"apps/v1\",\"kind\":\"StatefulSet\"..."

deploymentYamlstring

배포 정보(YAML)

Example: "apiVersion: apps/v1\nkind: StatefulSet\n..."

desiredPodCntinteger

제공할 파드 수

Example: 1

detailDetail (object)

annotationsobject

어노테이션

additionalPropstring

creationTimestring

생성 일시

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

labelsobject

라벨

additionalPropstring

namestring

StatefulSet 이름

Example: "cocktail-api-cmdb"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

podManagementPolicystring

초기 스케일업 중 노드의 파드 교체할 때 또는 축소할 때 포드 생성 방법 제어

Example: "OrderedReady"

podTemplateobject

파드 템플릿

additionalPropany

replicasinteger

replicas 수

Example: 1

revisionHistoryLimitstring

유지해야 하는 이전 replicaset의 수

Example: "10"

rollingUpdateobject

롤링 업데이트 관련 정보

additionalPropstring

selectorobject

상태 관련 정보

additionalPropstring

statusobject

상태 관련 정보

additionalPropstring

strategyobject

업데이트 Strategy 유형

Example: "RollingUpdate"

volumeClaimTemplatesarray of object

볼륨 claim 템플릿

imagesarray of string

이미지 목록

itemsstring

Example: "101.55.69.30/library/api-cmdb:4.7.4-release.20230413"

labelsobject

라벨

additionalPropstring

namestring

StatefulSet 이름

Example: "cocktail-api-cmdb"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

readyPodCntinteger

준비된 파드 수

Example: 1

Request

Response

Get cluster namespace Deployment details

Get detailed information for Deployment in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/deployments/{deploymentName}

Path parameters

clusterId*string

namespaceName*string

deploymentName*string

Response

Body

conditionsarray of Conditions (object)

status information

lastHeartbeatTimestring

Last measurement time

Example: "2023-05-02 07:12:02"

lastTransitionTimestring

Example: "2023-05-02 07:12:02"

messagestring

Example: "Deployment has minimum availability."

reasonstring

Example: "MinimumReplicasAvailable"

statusstring

status(True or False)

Example: "True"

typestring

Example: "Available"

creationTimestampstring

Example: "2023-05-02 07:12:02"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n..."

desiredPodCntinteger

Number of pods to provide

Example: 1

detailDetail (object)

annotationsobject

additionalPropstring

creationTimestring

Example: "2023-05-02 01:45:53"

labelsobject

additionalPropstring

minReadySecondsinteger

Minimum time to be ready

Example: 0

namestring

Deployement name

Example: "cocktail-log-api"

namespacestring

namespace name

Example: "cocktail-system"

podTemplateobject

additionalPropany

replicasinteger

replicas count

Example: 1

revisionHistoryLimitstring

Number of previous replicaset to maintain

Example: "10"

rollingUpdateobject

Rolling update-related information

additionalPropstring

selectorobject

State-related information

additionalPropstring

statusobject

State-related information

additionalPropstring

strategyobject

Status

Example: "RollingUpdate"

imagesarray of string

Image list

itemsstring

Example: "regi.acloud.run/library/log-api:1.3.0"

labelsobject

additionalPropstring

matchLabelsobject

match Label list

additionalPropstring

namestring

Deployement name

Example: "cocktail-log-api"

namespacestring

namespace name

Example: "cocktail-system"

newReplicaSetsarray of NewReplicaSets (object)

New replicaset information

creationTimestampstring

Example: "2023-06-28 08:10:52"

deploymentstring

ReplicaSet deployment information

Example: "{\"metadata\":{\"annotations\":{\"acornsoft.io/workload-group-no\":\"12\",\"cocktail-deploy-datetime..."

deploymentYamlstring

ReplicaSet deployment information(YAML)

Example: "metadata:\n annotations:\n acornsoft.io/workload-group-no: '12'\n cocktail-deploy-datetime..."

desiredPodCntinteger

Number of Pods to provide

Example: 1

detailobject

ReplicaSet Detailed information

additionalPropany

imagesarray of string

Image list

itemsstring

Example: "regi.acloud.run/library/log-api:1.3.0"

labelsobject

additionalPropstring

namestring

ReplicaSet name

Example: "cocktail-log-api-9d5bcff4"

namespacestring

namespace name

Example: "cocktail-system"

readyPodCntinteger

Number of ready Pods

Example: 1

readyPodCntinteger

Number of ready pods

Example: 1

Request

Response

Get cluster namespace HAPs list

Get the list of HPA in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/hpas

Path parameters

clusterId*string

namespaceName*string

Response

Body

conditionsarray of Conditions (object)

status information

lastTransitionTimestring

Example: "2023-06-28 05:47:42"

messagestring

Example: "recent recommendations were higher than current one, applying the highest recent recommendation"

reasonstring

Example: "ScaleDownStabilized"

statusstring

status(True or False)

Example: "True"

typestring

Example: "AbleToScale"

creationTimestampstring

Example: "2023-06-14 09:39:07"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"autoscaling/v2\",\"kind\":\"HorizontalPodAutoscaler\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: autoscaling/v2\nkind: HorizontalPodAutoscaler\nmetadata..."

detailDetail (object)

creationTimestring

Example: "2023-06-14 09:38:52"

currentReplicasinteger

Current replicas count

Example: 1

desiredReplicasinteger

Number of replicas to provide

Example: 1

labelsobject

additionalPropstring

lastScaleTimestring

Example: "2023-07-03 06:53:41"

maxReplicasinteger

Maximum replicas count

Example: 3

metricsarray of object

Target metric

additionalPropstring

minReplicasinteger

Minimum replicas count

Example: 2

namestring

Example: "api-server-hpa"

namespacestring

namespace name

Example: "cocktail-system"

targetstring

Example: "Deployment: cocktail-api-server"

maxReplicasinteger

Maximum replicas count

Example: 3

metricsarray of Metrics (object)

Target metric

currentAverageUtilizationinteger

Current value of the average pod resource metric (expressed as a percentage of requested resource values for pods)

Example: 0

currentAverageValuestring

Current value of the average pod metric

Example: "5m"

currentValueinteger

Current value of the metric (quantity)

metricTypestring

metricType(Object, Pods, Resource, External)

Example: "Resource"

namestring

Example: "cpu"

targetAverageUtilizationinteger

Average target value of pod resource metrics (expressed as a percentage of requested resource values for pods)

Example: 70

targetTypestring

Utilization or Value or AverageValue

Example: "Utilization"

minReplicasinteger

Minimum replicas count

Example: 2

namestring

HPA name

Example: "api-server-hpa"

namespacestring

namespace name

Example: "cocktail-system"

scaleTargetRefScaleTargetRef (object)

apiVersionstring

Example: "apps/v1"

kindstring

Example: "Deployment"

namestring

Example: "cocktail-api-server"

startTimestring

Example: "2023-06-28 05:47:26"

Request

Response

Get cluster namespace Container log

Get the logs of Containers in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/pods/{podName}/containers/log

Path parameters

clusterId*string

namespaceName*string

podName*string

Query parameters

type*string

Log Retrieval Method(tail or since)

countstring

The number of lines to read when the type is 'tail' (up to 10,000).

sinceSecondsstring

Return logs from before the value in seconds

Response

Body

containerNamestring

컨테이너 이름

Example: "api-cmdb"

logstring

로그

Example:

"2023-07-03  8:44:55 571828 [Warning] Aborted connection 571828 to db: 'acloud' user: 'root' host: '127.0.0.1' (Got timeout reading communication packets)\n..."

podNamestring

파드 이름

Example: "cocktail-api-cmdb-0"

Request

Response

Get cluster namespace Jobs list

Get the list of Jobs in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/jobs

Path parameters

clusterId*string

namespaceName*string

Response

Body

completionPodCntinteger

완료된 파드 수

Example: 1

creationTimestampstring

생성 일시

Example: "2023-05-15 09:45:06"

desiredPodCntinteger

제공할 파드 수

Example: 1

imagesarray of string

이미지 목록

itemsstring

Example: "docker.io/k8ssandra/k8ssandra-tools:latest"

labelsobject

라벨

additionalPropstring

namestring

Job 이름

Example: "k8ssandra-operator-crd-upgrader-job-k8ssandra"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

Request

Response

Get cluster configuration list

Get the list of settings for that cluster.

GET/v1/clusters/{clusterId}/settings

Path parameters

clusterId*string

Response

Body

creationTimestampstring

Example: "2023-06-12 01:16:43"

namestring

Configuration information name

Example: "cocktail-api-cmdb"

namespaceNamestring

Example: "cocktail-system"

typestring

Configuration information type

Example: "ConfigMap"

Request

Response

Get cluster workloads list

Get the workload list for that cluster.

GET/v1/clusters/{clusterId}/workloads

Path parameters

clusterId*string

Response

Body

activeCountinteger

Example: 1

computeTotalinteger

Total number of computes

Example: 1

creationTimestampstring

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

descriptionstring

Example: ""

isK8sResourceExistboolean

namespaceNamestring

Example: "cocktail-system"

qosstring

QoS

Example: "Burstable"

stateCodestring

stateCode(RUNNING, STOPPED)

Example: "RUNNING"

workloadGroupSeqinteger

Example: 11

workloadNamestring

Example: "cocktail-api-cmdb"

workloadTypestring

Example: "STATEFUL_SET_SERVER"

Request

Response

Get cluster node details

Return the cluster node event list.

GET/v1/clusters/{clusterId}/nodes/{nodeName}

Path parameters

clusterId*string

nodeName*string

Response

Body

allocatableAllocatable (object)

additionalPropobject

formatstring

DECIMAL_EXPONENT or DECIMAL_SI or BINARY_SI

numberinteger

capacityCapacity (object)

additionalPropobject

formatstring

DECIMAL_EXPONENT or DECIMAL_SI or BINARY_SI

numberinteger

conditionsarray of Conditions (object)

Node status information

lastHeartbeatTimestring

Last measurement time

Example: "2023-06-12 01:18:50"

lastTransitionTimestring

Example: "2023-06-12 01:18:50"

messagestring

Example: "Cilium is running on this node"

reasonstring

Example: "CalicoIsUp"

statusstring

status(True or False)

Example: "False"

typestring

Example: "NetworkUnavailable"

creationTimestampstring

Example: "2023-06-12 01:17:47"

detailDetail (object)

addressesobject

Allowed addresses on the node

annotationsobject

additionalPropstring

architecturestring

Example: "amd64"

bootIDstring

Example: "36955d45-9257-4ef8-815a-c3e2b142180e"

containerRuntimeVersionstring

Example: "containerd://1.6.10"

creationTimestring

Example: "2022-12-02 02:33:48"

kernelVersionstring

Example: "3.10.0-1160.24.1.el7.x86_64"

kubeProxyVersionstring

Example: "v1.23.14"

kubeletVersionstring

Example: "v1.23.14"

labelsobject

additionalPropstring

machineIDstring

Example: "14b02ba119194cb3980cd859ae208204"

namestring

node name

Example: "apps-gpu-v100"

operatingSystemstring

Example: "linux"

osImagestring

Example: "CentOS Linux 7 (Core)"

podCIDRstring

Pod IP range allocated to the node

Example: "0.0.0.0/0"

systemUUIDstring

Example: "4C4C4544-004A-4E10-8032-B4C04F383233"

unschedulableboolean

Node scheduling for new pods(nodes are schedulable by default)

Example: "false"

labelsobject

additionalPropstring

namestring

Example: "apps-gpu-v100"

readystring

ready(True or False)

Example: "True"

Request

const response = await fetch('/v1/clusters/{clusterId}/nodes/{nodeName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "allocatable": {
    "additionalProp": {
      "format": "text"
    }
  },
  "capacity": {
    "additionalProp": {
      "format": "text"
    }
  },
  "conditions": [
    {
      "lastHeartbeatTime": "2023-06-12 01:18:50",
      "lastTransitionTime": "2023-06-12 01:18:50",
      "message": "Cilium is running on this node",
      "reason": "CalicoIsUp",
      "status": "False",
      "type": "NetworkUnavailable"
    }
  ],
  "creationTimestamp": "2023-06-12 01:17:47",
  "detail": {
    "addresses": {
      "Hostname": "apps-gpu-v100",
      "InternalIP": "0.0.0.0"
    },
    "annotations": {
      "csi.volume.kubernetes.io/nodeid": "{\"nfs.csi.k8s.io\":\"apps-gpu-v100\"}",
      "kubeadm.alpha.kubernetes.io/cri-socket": "unix:///run/containerd/containerd.sock",
      "nfd.node.kubernetes.io/extended-resources": ""
    },
    "architecture": "amd64",
    "bootID": "36955d45-9257-4ef8-815a-c3e2b142180e",
    "containerRuntimeVersion": "containerd://1.6.10",
    "creationTime": "2022-12-02 02:33:48",
    "kernelVersion": "3.10.0-1160.24.1.el7.x86_64",
    "kubeProxyVersion": "v1.23.14",
    "kubeletVersion": "v1.23.14",
    "labels": {
      "beta.kubernetes.io/arch": "amd64",
      "beta.kubernetes.io/os": "linux",
      "cube.acornsoft.io/clusterid": "cube"
    },
    "machineID": "14b02ba119194cb3980cd859ae208204",
    "name": "apps-gpu-v100",
    "operatingSystem": "linux",
    "osImage": "CentOS Linux 7 (Core)",
    "podCIDR": "0.0.0.0/0",
    "systemUUID": "4C4C4544-004A-4E10-8032-B4C04F383233",
    "unschedulable": "false"
  },
  "labels": {
    "beta.kubernetes.io/arch": "amd64",
    "beta.kubernetes.io/os": "linux",
    "cube.acornsoft.io/clusterid": "cube"
  },
  "name": "apps-gpu-v100",
  "ready": "True"
}

Get cluster namespace pods logs

Get the list of Pods in the specified cluster and namespace..

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/pods

Path parameters

clusterId*string

namespaceName*string

Response

Body

conditionsarray of Conditions (object)

상태 정보

lastTransitionTimestring

마지막 전송 시각

Example: "22023-05-01 09:20:19"

statusstring

True or False

Example: "True"

typestring

유형

Example: "Initialized"

detailDetail (object)

annotationsobject

어노테이션

additionalPropstring

containersarray of object

컨테이너 정보

additionalPropany

creationTimestampstring

생성 일시

Example: "2023-05-01 09:20:09"

hostnamestring

호스트 이름

Example: "cocktail-api-cmdb-0"

initContainersarray of object

additionalPropany

labelsobject

라벨

additionalPropstring

namespacestring

네임스페이스 이름

Example: "cocktail-system"

nodeNamestring

네임스페이스 이름

Example: "apps-gpu-v100"

ownerReferencesarray of object

참조 정보

additionalPropstring

podIPstring

파드 IP

Example: "0.0.0.0"

podNamestring

파드 이름

Example: "cocktail-api-cmdb-0"

podStatusstring

파드 상태

Example: "Running"

qosClassstring

QoS 클래스

Example: "Burstable"

restartPolicystring

재시작 정책

Example: "Always"

serviceAccountNamestring

서비스 계정 이름

Example: "default"

startTimestring

시작 시각

Example: "2023-05-01 09:20:09"

terminationGracePeriodSecondsinteger

종료 시 유예 시간

Example: 60

tolerationsarray of object

toleration 정보 목록

additionalPropstring

namespacestring

네임스페이스 이름

Example: "cocktail-system"

nodeNamestring

노드 이름

Example: "apps-gpu-v100"

podNamestring

파드 이름

Example: "cocktail-api-cmdb-0"

podStatusstring

파드 상태

Example: "Running"

restartCntinteger

재시작 파드 수

Example: 0

startTimestring

시작 시각

Example: "2023-05-01 09:20:09"

Request

Response

Get cluster namespace details

Get the namespace details of the cluster.

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

Path parameters

clusterId*string

namespaceName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2022-12-02 06:21:35"

deploymentstring

Deployment information

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

deploymentYamlstring

Deployment information(YAML)

Example: "apiVersion: v1\nkind: Node\nmetadata..."

detailDetail (object)

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2022-12-02 06:21:35"

labelsobject

additionalPropstring

namestring

Namespace name

Example: "cocktail-system"

statusstring

Example: "Active"

labelsobject

additionalPropstring

namestring

Namespace name

Example: "cocktail-system"

statusstring

Example: "Active"

Request

Response

Get cluster pods list

Get the list of the cluster.

GET/v1/clusters/{clusterId}/pods

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

labesobject

additionalPropstring

namespacestring

namespace name

Example: "cocktail-system"

nodeNamestring

Example: "apps-gpu-v100"

podNamestring

Example: "cocktail-api-cmdb-0"

podStatusstring

podStatus(RUNNING, STOPPED)

Example: "Running"

restartCntinteger

Example: 0

startTimestring

Example: "2023-05-01 09:20:09"

Request

Response

Get cluster namespace ingress details

Get detailed information for the Ingress in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/ingresses/{ingressName}

Path parameters

clusterId*string

namespaceName*string

ingressName*string

Response

Body

creationTimestampstring

Example: "2023-06-15 07:52:17"

deploymentstring

Deployment information

Example: "{\"apiVersion\":\"networking.k8s.io/v1\"..."

deploymentYamlstring

Deployment information(YAML)

Example: "apiVersion: v1\nkind: Node\nmetadata..."

detailDetail (object)

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2023-01-12 08:33:06"

labelsobject

additionalPropstring

namestring

Ingress name

Example: "api"

namespacestring

namespace name

Example: "cocktail-system"

endpointsarray of string

Endpoint list

itemsstring

Example: "0.0.0.0"

ingressSpecIngressSpec (object)

annotationsobject

additionalPropstring

ingressControllerNamestring

Example: "nginx"

labelsobject

additionalPropstring

namestring

Ingress name

Example: "api"

namespaceNamestring

namespace name

Example: "cocktail-system"

rulesarray of object

Policy rule

additionalPropany

tlsarray of object

Ingress TLS

additionalPropany

useSslRedirectboolean

SSL Redirect enabled

Example: false

namestring

Ingress name

Example: "api"

namespacestring

namespace name

Example: "cocktail-system"

Request

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

Response

{
  "creationTimestamp": "2023-06-15 07:52:17",
  "deployment": "{\"apiVersion\":\"networking.k8s.io/v1\"...",
  "deploymentYaml": "apiVersion: v1\nkind: Node\nmetadata...",
  "detail": {
    "annotations": {
      "nginx.ingress.kubernetes.io/ssl-redirect": "false"
    },
    "creationTimestamp": "2023-01-12 08:33:06",
    "labels": {
      "app": "api"
    },
    "name": "api",
    "namespace": "cocktail-system"
  },
  "endpoints": [
    "0.0.0.0"
  ],
  "ingressSpec": {
    "annotations": {
      "nginx.ingress.kubernetes.io/ssl-redirect": "false"
    },
    "ingressControllerName": "nginx",
    "labels": {
      "app": "api"
    },
    "name": "api",
    "namespaceName": "cocktail-system",
    "rules": [
      {
        "host": {
          "type": "string",
          "example": "devops-api.acloud.run"
        },
        "paths": {
          "type": "array",
          "description": "<p>Path list</p>",
          "items": {
            "type": "object",
            "example": {
              "path": "/v1",
              "pathType": "ImplementationSpecific",
              "serviceName": "api-gateway",
              "servicePort": "8081",
              "servicePortIsInteger": true
            }
          },
          "__$markdownParsed": true
        }
      }
    ],
    "tls": [
      {
        "hosts": [
          "devops-api.acloud.run"
        ],
        "secretName": "acloudrun-tls"
      }
    ],
    "useSslRedirect": false
  },
  "name": "api",
  "namespace": "cocktail-system"
}

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"
}

Get cluster storage list

Get the storage list of the cluster.

GET/v1/clusters/{clusterId}/storages

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

baseStorageYnstring

Default storage availability (Y: Allowed, N: Not allowed)

Example: "Y"

descriptionstring

Example: ""

labelsobject

additionalPropstring

mountOptionsarray of string

List of mount options

itemsstring

namestring

Storage name

Example: "nfs-csi"

parametersarray of object

Parameter list

namestring

Parameter name

valuestring

Parameter value

phasestring

Volume status (Only used in Static Volume)(UNKNOWN, AVAILABLE, BOUND, RELEASED, FAILED, DELETED)

Example: "AVAILABLE"

pluginstring

Example: "NFS_CSI"

provisionerNamestring

Example: "nfs.csi.k8s.io"

readOnlyManyYnstring

Volume request ReadOnlyMany support availability(Y: Allowed, N: Not allowed)

Example: "Y"

readWriteManyYnstring

Volume request ReadWriteMany support availability(Y : Allowed, N: Not allowed)

Example: "Y"

readWriteOnceYnstring

Volume request readWriteOnceYn support availability(Y : Allowed, N: Not allowed)

Example: "Y"

reclaimPolicystring

reclaimPolicy(RECYCLE, RETAIN, DELETE, RECYCLE, RETAIN, DELETE)

Example: "RETAIN"

storageTypestring

storageType(BLOCK, NETWORK, BLOCK, NETWORK)

Example: "NETWORK"

totalCapacityinteger

Example: 1024

typestring

Configuration type(None, HOST_PATH, EMPTY_DIR, CONFIG_MAP, SECRET, PERSISTENT_VOLUME_STATIC, PERSISTENT_VOLUME_LINKED, PERSISTENT_VOLUME)

Example: "PERSISTENT_VOLUME"

volumeBindingModestring

volumeBindingMode(IMMEDIATE, WAIT_FOR_FIRST_CONSUMER, IMMEDIATE, WAIT_FOR_FIRST_CONSUMER)

Example: "IMMEDIATE"

Request

Response

Get cluster namespace PVC list

Get cluster namespace PVC details.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/persistentvolumeclaims

Path parameters

clusterId*string

namespaceName*string

Response

Body

accessModesarray of string

access Mode list

itemsstring

Example: "ReadWriteMany"

capacityobject

additionalPropstring

creationTimestampstring

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

namestring

PVC name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

persistentVolumeTypestring

PVC type(SINGLE, SHARED)

Example: "SHARED"

statusstring

PVC tatus

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

Request

Response

Get cluster namespace configmap details

Get detailed information for the ConfigMap in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/configmaps/{configmapName}

Path parameters

clusterId*string

namespaceName*string

configmapName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

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

dataData (object)

additionalPropstring

deploymentstring

deployment information

Example: "{\"apiVersion\":\"v1\",\"data\":{\"my.cnf\":\"[client]..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: v1\nkind: ConfigMap\nmetadata..."

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

configmap name

Example: "cocktail-api-cmdb"

namespacestring

네namespace name

Example: "cocktail-system"

Request

Response

Get cluster namespace PVC details

Get detailed information for PVC in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/persistentvolumeclaims/{pvcName}

Path parameters

clusterId*string

namespaceName*string

pvcName*string

Response

Body

accessModesarray of string

access Mode lis

itemsstring

Example: "ReadWriteMany"

capacityobject

additionalPropstring

clusterVolumeClusterVolume (object)

annotationsobject

additionalPropstring

baseStorageYnstring

Default storage availability (Y: Allowed, N: Not allowed)

Example: "Y"

descriptionstring

Example: ""

labelsobject

additionalPropstring

mountOptionsarray of string

Cluster volume mount options list

itemsstring

namestring

PVC name

Example: "nfs-csi"

parametersarray of object

Parameter list

namestring

Parameter name

valuestring

Parameter value

phasestring

Volume status (Only used in Static Volume)(UNKNOWN, AVAILABLE, BOUND, RELEASED, FAILED, DELETED)

Example: "AVAILABLE"

pluginstring

Example: "NFS_CSI"

provisionerNamestring

Example: "nfs.csi.k8s.io"

readOnlyManyYnstring

Support for ReadOnlyMany volume requests (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteManyYnstring

Support for ReadWriteMany volume requests (Y: Allowed, N: Not allowed)

Example: "Y"

readWriteOnceYnstring

Support for readWriteOnceYn volume requests (Y: Allowed, N: Not allowed)

Example: "Y"

reclaimPolicystring

reclaimPolicy(RECYCLE, RETAIN, DELETE, RECYCLE, RETAIN, DELETE)

Example: "RETAIN"

storageTypestring

storage Type(NETWORK, BLOCK)

Example: "NETWORK"

totalCapacityinteger

Example: 1024

typestring

type(PERSISTENT_VOLUME, PERSISTENT_VOLUME_STATIC)

Example: "PERSISTENT_VOLUME"

volumeBindingModestring

volumeBindingMode(IMMEDIATE, WAIT_FOR_FIRST_CONSUMER, IMMEDIATE, WAIT_FOR_FIRST_CONSUMER)

Example: "IMMEDIATE"

creationTimestampstring

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

deploymentstring

deployment information

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

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:..."

detailDetail (object)

accessModesarray of string

access Mode list

itemsstring

Example: "ReadWriteMany"

annotationsobject

additionalPropstring

capacityobject

additionalPropstring

creationTimestampstring

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

labelsobject

additionalPropstring

namestring

Persistent Volume name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

namestring

Persistent Volume name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

persistentVolumePersistentVolume (object)

accessModesarray of string

access Mode list

itemsstring

Example: "ReadWriteMany"

capacityobject

additionalPropstring

claimNamestring

PVC name

Example: "cocktail-api-cmdb-logdata"

claimNameWithNamespacestring

PVC name with namespace

Example: "cocktail-system/cocktail-api-cmdb-logdata"

creationTimestampstring

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

deploymentstring

deployment information

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

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: v1\nkind: PersistentVolume\nmetadata..."

detailobject

Detailed information

additionalPropany

namestring

Volume name

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

persistentVolumeReclaimPolicystring

Reclaim policy name

Example: "Retain"

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

persistentVolumeTypestring

Persistent Volume type(SINGLE, SHARED)

Example: "SHARED"

serverParamsarray of ServerParams (object)

Server parameter information

containerVolumesarray of object

Container volume information

additionalPropany

namespaceNamestring

Example: "cocktail-system"

serverNamestring

Example: "cocktail-api-cmdb"

statusstring

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

Request

Response

Get cluster namespace secret list

Get the list of Secrets in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/secrets

Path parameters

clusterId*string

namespaceName*string

Response

Body

creationTimestampstring

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

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

Secret name

Example: "cocktail-api-cmdb"

namespacestring

namespace name

Example: "cocktail-system"

typestring

Secret type(Generic, DockerRegistry, Tls, BasicAuth, SshAuth)

Example: "Generic"

Request

Response

Get cluster namespace DaemonSet details

Get detailed information for DaemonSet in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/daemonsets/{daemonSetName}

Path parameters

clusterId*string

namespaceName*string

daemonSetName*string

Response

Body

creationTimestampstring

Example: "2023-06-21 06:41:56"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"apps/v1\",\"kind\":\"DaemonSet\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: apps/v1\nkind: DaemonSet\nmetadata:\n..."

desiredPodCntinteger

Number of pods to provide

Example: 7

detailDetail (object)

annotationsobject

additionalPropstring

creationTimestring

Example: "2023-06-21 06:41:56"

labelsobject

additionalPropstring

minReadySecondsinteger

Minimum time to be ready

Example: 0

namestring

DaemonSet name

Example: "promtail"

namespacestring

namespace name

Example: "cocktail-system"

podTemplateobject

additionalPropany

revisionHistoryLimitstring

Number of previous replicaset to maintain

Example: "10"

rollingUpdateobject

Rolling update related information

additionalPropstring

selectorobject

State-related information

additionalPropstring

statusobject

State-related information

additionalPropstring

strategyobject

update Strategy type

Example: "RollingUpdate"

imagesarray of string

Image list

itemsstring

Example: "101.55.69.30/docker.io/grafana/promtail:2.7.4"

labelsobject

additionalPropstring

namestring

DaemonSet name

Example: "promtail"

namespacestring

namespace name

Example: "cocktail-system"

readyPodCntinteger

Number of ready pods

Example: 7

Request

Response

{
  "accessModes": [
    "ReadWriteMany"
  ],
  "capacity": {
    "storage": "20Gi"
  },
  "clusterVolume": {
    "annotations": {
      "cocktail-user-description": "bmZzLWNzaQ==",
      "meta.helm.sh/release-name": "default-storage",
      "meta.helm.sh/release-namespace": "kube-system"
    },
    "baseStorageYn": "Y",
    "description": "",
    "labels": {
      "acornsoft.io/provisioner-type": "NFS_CSI",
      "acornsoft.io/total-capacity": "1024",
      "acornsoft.io/type": "NETWORK"
    },
    "mountOptions": [
      "hard",
      "nfsvers=4.1"
    ],
    "name": "nfs-csi",
    "parameters": [
      {
        "name": "server",
        "value": "0.0.0.0"
      }
    ],
    "phase": "AVAILABLE",
    "plugin": "NFS_CSI",
    "provisionerName": "nfs.csi.k8s.io",
    "readOnlyManyYn": "Y",
    "readWriteManyYn": "Y",
    "readWriteOnceYn": "Y",
    "reclaimPolicy": "RETAIN",
    "storageType": "NETWORK",
    "totalCapacity": 1024,
    "type": "PERSISTENT_VOLUME",
    "volumeBindingMode": "IMMEDIATE"
  },
  "creationTimestamp": "2023-04-29 05:54:51",
  "deployment": "{\"apiVersion\":\"v1\",\"kind\":\"PersistentVolumeClaim\"...",
  "deploymentYaml": "apiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:...",
  "detail": {
    "accessModes": [
      "ReadWriteMany"
    ],
    "annotations": {
      "meta.helm.sh/release-name": "cocktail",
      "meta.helm.sh/release-namespace": "cocktail-system",
      "pv.kubernetes.io/bind-completed": "yes"
    },
    "capacity": {
      "storage": "20Gi"
    },
    "creationTimestamp": "2023-04-29 05:54:51",
    "labels": {
      "app.kubernetes.io/instance": "cocktail",
      "app.kubernetes.io/managed-by": "Helm",
      "app.kubernetes.io/name": "api-cmdb"
    },
    "name": "cocktail-api-cmdb-logdata",
    "namespace": "cocktail-system",
    "status": "Bound",
    "storageClassName": "nfs-csi",
    "volumeName": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"
  },
  "name": "cocktail-api-cmdb-logdata",
  "namespace": "cocktail-system",
  "persistentVolume": {
    "accessModes": [
      "ReadWriteMany"
    ],
    "capacity": {
      "storage": "20Gi"
    },
    "claimName": "cocktail-api-cmdb-logdata",
    "claimNameWithNamespace": "cocktail-system/cocktail-api-cmdb-logdata",
    "creationTimestamp": "2023-04-29 05:54:51",
    "deployment": "{\"apiVersion\":\"v1\",\"kind\":\"PersistentVolume...",
    "deploymentYaml": "apiVersion: v1\nkind: PersistentVolume\nmetadata...",
    "detail": {
      "accessModes": [
        "ReadWriteMany"
      ],
      "annotations": {
        "pv.kubernetes.io/provisioned-by": "nfs.csi.k8s.io",
        "volume.kubernetes.io/provisioner-deletion-secret-name": "",
        "volume.kubernetes.io/provisioner-deletion-secret-namespace": ""
      },
      "capacity": {
        "storage": "20Gi"
      },
      "claimName": "cocktail-system/cocktail-api-cmdb-logdata",
      "creationTime": "2023-04-29 05:54:51",
      "events": [
        {
          "message": "",
          "source": "",
          "subObject": "",
          "count": 0,
          "firstTime": "2023-04-29 05:54:51",
          "lastTime": "2023-04-29 05:54:51",
          "kind": "",
          "name": "",
          "namespace": "",
          "involvedObject": {
            "apiVersion": "",
            "fieldPath": "",
            "kind": "",
            "name": "",
            "namespace": "",
            "resourceVersion": "",
            "uid": ""
          },
          "related": {
            "apiVersion": "",
            "fieldPath": "",
            "kind": "",
            "name": "",
            "namespace": "",
            "resourceVersion": "",
            "uid": ""
          },
          "deployment": "",
          "deploymentYaml": ""
        }
      ],
      "labels": {
        "app.kubernetes.io/instance": "cocktail",
        "app.kubernetes.io/managed-by": "Helm",
        "app.kubernetes.io/name": "api-cmdb"
      },
      "name": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482",
      "persistentVolumeReclaimPolicy": "Retain",
      "status": "Bound",
      "StatusMessage": "",
      "statusReason": "",
      "storageClassName": "nfs-csi",
      "volumeMode": "",
      "volumeSource": "{\"csi\":{\"driver\":\"nfs.csi.k8s.io\",\"volumeAttributes\":..."
    },
    "name": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482",
    "persistentVolumeReclaimPolicy": "Retain",
    "status": "Bound",
    "storageClassName": "nfs-csi"
  },
  "persistentVolumeType": "SHARED",
  "serverParams": [
    {
      "containerVolumes": [
        {
          "containerName": "api-cmdb",
          "containerPath": "/var/log/mysql",
          "subPath": "api-cmdb",
          "useMemoryYn": "N",
          "volumeName": "log"
        }
      ],
      "namespaceName": "cocktail-system",
      "serverName": "cocktail-api-cmdb"
    }
  ],
  "status": "Bound",
  "storageClassName": "nfs-csi",
  "volumeName": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"
}

[
  {
    "creationTimestamp": "2023-06-21 06:41:56",
    "deployment": "{\"apiVersion\":\"apps/v1\",\"kind\":\"DaemonSet\"...",
    "deploymentYaml": "apiVersion: apps/v1\nkind: DaemonSet\nmetadata:\n...",
    "desiredPodCnt": 7,
    "detail": {
      "annotations": {
        "deprecated.daemonset.template.generation": "5",
        "meta.helm.sh/release-name": "promtail",
        "meta.helm.sh/release-namespace": "cocktail-system"
      },
      "creationTime": "2023-06-21 06:41:56",
      "labels": {
        "app.kubernetes.io/instance": "promtail",
        "app.kubernetes.io/managed-by": "Helm",
        "app.kubernetes.io/name": "promtail"
      },
      "minReadySeconds": 0,
      "name": "promtail",
      "namespace": "cocktail-system",
      "podTemplate": {
        "annotations": {
          "checksum/config": "c0bfd056325ee83005df0c32ca6018bdcd2e31066846277781c9b68dfe1f9b88"
        },
        "labels": {
          "app.kubernetes.io/instance": "promtail",
          "app.kubernetes.io/name": "promtail"
        },
        "spec": {
          "conditions": [],
          "detail": {
            "containers": [
              {
                "args": [
                  "-config.file=/etc/promtail/promtail.yaml"
                ],
                "environmentVariables": {
                  "HOSTNAME": "{\"apiVersion\":\"v1\",\"fieldPath\":\"spec.nodeName\"}"
                },
                "image": "101.55.69.30/docker.io/grafana/promtail:2.7.4",
                "imagePullPolicy": "IfNotPresent",
                "name": "promtail",
                "resources": {},
                "restartCount": 0,
                "volumeMounts": {
                  "applications": "{\"mountPath\":\"/var/log/applications\",\"name\":\"applications\"}",
                  "audit": "{\"mountPath\":\"/var/log/kubernetes\",\"name\":\"audit\",\"readOnly\":true}",
                  "config": "{\"mountPath\":\"/etc/promtail\",\"name\":\"config\"}",
                  "containers": "{\"mountPath\":\"/var/log/containers\",\"name\":\"containers\",\"readOnly\":true}",
                  "cricontainers": "{\"mountPath\":\"/var/lib/containerd/io.containerd.grpc.v1.cri/containers\",\"name\":\"cricontainers\",\"readOnly\":true}",
                  "pods": "{\"mountPath\":\"/var/log/pods\",\"name\":\"pods\",\"readOnly\":true}",
                  "run": "{\"mountPath\":\"/run/promtail\",\"name\":\"run\"}"
                }
              }
            ],
            "initContainers": [],
            "restartPolicy": "Always",
            "serviceAccountName": "promtail",
            "terminationGracePeriodSeconds": 30,
            "tolerations": [
              {
                "operator": "Exists"
              }
            ]
          },
          "podStatus": "Pending",
          "restartCnt": 0
        }
      },
      "revisionHistoryLimit": "10",
      "rollingUpdate": {
        "maxSurge": 0,
        "maxUnavailable": 1
      },
      "selector": {
        "matchLabels": {
          "app.kubernetes.io/instance": "promtail",
          "app.kubernetes.io/name": "promtail"
        }
      },
      "status": {
        "available": 7,
        "current": 7,
        "desired": 7,
        "ready": 7,
        "up-to-date": 7
      },
      "strategy": "RollingUpdate"
    },
    "images": [
      "101.55.69.30/docker.io/grafana/promtail:2.7.4"
    ],
    "labels": {
      "app.kubernetes.io/instance": "promtail",
      "app.kubernetes.io/managed-by": "Helm",
      "app.kubernetes.io/name": "promtail"
    },
    "name": "promtail",
    "namespace": "cocktail-system",
    "readyPodCnt": 7
  }
]

Get cluster namespace Deployments list

Get the list of Deployments in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/deployments

Path parameters

clusterId*string

namespaceName*string

Response

Body

conditionsarray of Conditions (object)

status information

lastHeartbeatTimestring

Last measurement time

Example: "2023-05-02 07:12:02"

lastTransitionTimestring

Example: "2023-05-02 07:12:02"

messagestring

Example: "Deployment has minimum availability."

reasonstring

Example: "MinimumReplicasAvailable"

statusstring

status(True or False)

Example: "True"

typestring

Example: "Available"

creationTimestampstring

Example: "2023-05-02 07:12:02"

desiredPodCntinteger

Number of pods to provide

Example: 1

imagesarray of string

Image list

itemsstring

Example: "regi.acloud.run/library/log-api:1.3.0"

labelsobject

additionalPropstring

matchLabelsobject

match label list

additionalPropstring

namestring

Deployement name

Example: "cocktail-log-api"

namespacestring

namespace name

Example: "cocktail-system"

readyPodCntinteger

Number of ready pods

Example: 1

Request

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

Response

[
  {
    "conditions": [
      {
        "lastHeartbeatTime": "2023-05-02 07:12:02",
        "lastTransitionTime": "2023-05-02 07:12:02",
        "message": "Deployment has minimum availability.",
        "reason": "MinimumReplicasAvailable",
        "status": "True",
        "type": "Available"
      }
    ],
    "creationTimestamp": "2023-05-02 07:12:02",
    "desiredPodCnt": 1,
    "images": [
      "regi.acloud.run/library/log-api:1.3.0"
    ],
    "labels": {
      "app": "api",
      "app.kubernetes.io/managed-by": "Helm",
      "chart": "api-1.0.0"
    },
    "matchLabels": {
      "app.kubernetes.io/app": "cocktail-log-api",
      "app.kubernetes.io/instance": "cocktail-log",
      "app.kubernetes.io/name": "api"
    },
    "name": "cocktail-log-api",
    "namespace": "cocktail-system",
    "readyPodCnt": 1
  }
]

Get cluster namespace secret details

Get detailed information for the Secret in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/secrets/{secretName}

Path parameters

clusterId*string

namespaceName*string

secretName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

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

dataData (object)

additionalPropstring

deploymentstring

Deployment informatio

Example: "{\"apiVersion\":\"v1\",\"data\"..."

deploymentYamlstring

Deployment informatio(YAML)

Example: "apiVersion: v1\nkind: Secret\nmetadata:\n..."

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

Secret name

Example: "cocktail-api-cmdb"

namespacestring

namespace name

Example: "cocktail-system"

typestring

Secret type(Generic, DockerRegistry, Tls, BasicAuth, SshAuth)

Example: "Generic"

Request

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

Response

{
  "annotations": {
    "meta.helm.sh/release-name": "cocktail",
    "meta.helm.sh/release-namespace": "cocktail-system"
  },
  "creationTimestamp": "2023-04-29 05:54:51",
  "data": {
    "additionalProp": "text"
  },
  "deployment": "{\"apiVersion\":\"v1\",\"data\"...",
  "deploymentYaml": "apiVersion: v1\nkind: Secret\nmetadata:\n...",
  "description": "",
  "labels": {
    "app.kubernetes.io/instance": "cocktail",
    "app.kubernetes.io/managed-by": "Helm",
    "app.kubernetes.io/name": "api-cmdb"
  },
  "name": "cocktail-api-cmdb",
  "namespace": "cocktail-system",
  "type": "Generic"
}

Get cluster namespace configmap list

Get the list of ConfigMaps in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/configmaps

Path parameters

clusterId*string

namespaceName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

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

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

configmap name

Example: "cocktail-api-cmdb"

namespacestring

namespace name

Example: "cocktail-system"

Request

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

Response

[
  {
    "annotations": {
      "meta.helm.sh/release-name": "cocktail",
      "meta.helm.sh/release-namespace": "cocktail-system"
    },
    "creationTimestamp": "2023-04-29 05:54:51",
    "description": "",
    "labels": {
      "app.kubernetes.io/instance": "cocktail",
      "app.kubernetes.io/managed-by": "Helm",
      "app.kubernetes.io/name": "api-cmdb"
    },
    "name": "cocktail-api-cmdb",
    "namespace": "cocktail-system"
  }
]

Get cluster namespace Job details

Get detailed information for Job in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/jobs/{jobName}

Path parameters

clusterId*string

namespaceName*string

jobName*string

Response

Body

completionPodCntinteger

완료된 파드 수

Example: 1

creationTimestampstring

생성 일시

Example: "2023-05-15 09:45:06"

deploymentstring

배포 정보

Example: "{\"apiVersion\":\"batch/v1\",\"kind\":\"Job\"..."

deploymentYamlstring

배포 정보(YAML)

Example: "apiVersion: batch/v1\nkind: Job\nmetadata:\n..."

desiredPodCntinteger

제공할 파드 수

Example: 1

detailDetail (object)

annotationsobject

어노테이션

additionalPropstring

backoffLimitinteger

job이 실패할 경우 재시작을 시도 횟수

Example: 3

completionsinteger

완료 개수

Example: 1

creationTimestring

생성 일시

Example: "2023-05-15 09:45:06"

labelsobject

라벨

additionalPropstring

namestring

Job 이름

Example: "cocktail-system-crd-upgrader-job-k8ssandra"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

parallelisminteger

parallelism

Example: 1

podTemplateobject

파드 템플릿

additionalPropany

selectorobject

상태 관련 정보

additionalPropstring

statusobject

상태 관련 정보

additionalPropstring

imagesarray of string

이미지 목록

itemsstring

Example: "docker.io/k8ssandra/k8ssandra-tools:latest"

labelsobject

라벨

additionalPropstring

namestring

Job 이름

Example: "cocktail-system-crd-upgrader-job-k8ssandra"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

Request

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

Response

[
  {
    "completionPodCnt": 1,
    "creationTimestamp": "2023-05-15 09:45:06",
    "deployment": "{\"apiVersion\":\"batch/v1\",\"kind\":\"Job\"...",
    "deploymentYaml": "apiVersion: batch/v1\nkind: Job\nmetadata:\n...",
    "desiredPodCnt": 1,
    "detail": {
      "annotations": {
        "helm.sh/hook": "pre-upgrade",
        "helm.sh/hook-delete-policy": "before-hook-creation",
        "helm.sh/hook-weight": "10"
      },
      "backoffLimit": 3,
      "completions": 1,
      "creationTime": "2023-05-15 09:45:06",
      "labels": {
        "app.kubernetes.io/instance": "cocktail-system",
        "app.kubernetes.io/managed-by": "Helm",
        "app.kubernetes.io/name": "cocktail-system"
      },
      "name": "cocktail-system-crd-upgrader-job-k8ssandra",
      "namespace": "cocktail-system",
      "parallelism": 1,
      "podTemplate": {
        "labels": {
          "app.kubernetes.io/instance": "cocktail-system",
          "app.kubernetes.io/managed-by": "Helm",
          "app.kubernetes.io/name": "cocktail-system",
          "app.kubernetes.io/part-of": "k8ssandra-cocktail-system-cocktail-system",
          "controller-uid": "60ccf04f-8999-474e-a38b-61633fcbaa39",
          "helm.sh/chart": "cocktail-system-1.6.1",
          "job-name": "cocktail-system-crd-upgrader-job-k8ssandra"
        },
        "spec": {
          "conditions": [],
          "cpuUsage": 0,
          "detail": {
            "containers": [
              {
                "args": [
                  "-upgradecrds",
                  "--targetVersion",
                  "1.6.1",
                  "--chartName",
                  "cocktail-system"
                ],
                "environmentVariables": {
                  "POD_NAMESPACE": "{\"apiVersion\":\"v1\",\"fieldPath\":\"metadata.namespace\"}"
                },
                "image": "docker.io/k8ssandra/k8ssandra-tools:latest",
                "imagePullPolicy": "IfNotPresent",
                "name": "crd-upgrade-job-k8ssandra",
                "resources": {},
                "restartCount": 0
              }
            ],
            "initContainers": [],
            "restartPolicy": "OnFailure",
            "serviceAccountName": "cocktail-system-crd-upgrader-k8ssandra",
            "terminationGracePeriodSeconds": 30
          },
          "memUsage": 0,
          "podStatus": "Pending",
          "restartCnt": 0
        }
      },
      "selector": {
        "matchLabels": {
          "controller-uid": "60ccf04f-8999-474e-a38b-61633fcbaa39"
        }
      },
      "status": {
        "Failed": 0,
        "Running": 0,
        "Succeeded": 1
      }
    },
    "images": [
      "docker.io/k8ssandra/k8ssandra-tools:latest"
    ],
    "labels": {
      "app.kubernetes.io/instance": "cocktail-system",
      "app.kubernetes.io/managed-by": "Helm",
      "app.kubernetes.io/name": "cocktail-system"
    },
    "name": "cocktail-system-crd-upgrader-job-k8ssandra",
    "namespace": "cocktail-system"
  }
]

Get cluster package list

Get the list of packages in the cluster.

GET/v1/clusters/{clusterId}/packages

Path parameters

clusterId*string

Response

Body

appVersionstring

Example: "4.7.3"

chartNamestring

Example: "cocktail"

chartVersionstring

Example: "4.7.4"

infoInfo (object)

deletedstring

Deletion time

Example: "0001-01-01 00:00:00 +0000 UTC"

descriptionstring

Example: ""

firstDeployedstring

First deployment datetime

Example: "2023-04-29 05:54:50.086853557 +0000 UTC"

iconstring

Example: ""

lastDeployedstring

Last deployment datetime

Example: "2023-04-29 06:04:37.924985116 +0000 UTC"

notesstring

Example: ""

readmestring

Read Me

Example: ""

statusstring

Example: "deployed"

namestring

Package name

Example: "cocktail"

namespacestring

Namespace name

Example: "cocktail-system"

revisionstring

Example: "2"

Request

Response

Get cluster namespace service exposure list

Get the list of exposed services in the specified cluster and namespace.

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

Path parameters

clusterId*string

namespaceName*string

Response

Body

annotationsobject

additionalPropstring

clusterIPstring

Example: "0.0.0.0"

creationTimestampstring

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

internalLBFlagboolean

Internal load balancer availability

Example: false

labelsobject

additionalPropstring

namespacestring

Namespace name

Example: "cocktail-system"

serviceNamestring

Example: "api-cmdb"

servicePortsServicePorts (object)

portstring

Example: "0"

protocolstring

Example: "TCP"

serviceUrlstring

Example: "10.187.158.194:3306"

targetPortstring

Example: "3306"

sessionAffinitystring

Session Affinity

Example: "None"

typestring

Example: "ClusterIP"

Request

Response

Get cluster service exposures list

Get the list of service exposures for that cluster.

GET/v1/clusters/{clusterId}/services

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

clusterIPstring

Example: "0.0.0.0"

creationTimestampstring

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

internalLBFlagboolean

Internal load balancer availability

Example: false

labelsobject

additionalPropstring

namespacestring

namespace name

Example: "cocktail-system"

serviceNamestring

Example: "api-cmd"

servicePortsarray of ServicePorts (object)

Port list

portstring

Example: "0"

protocolstring

Example: "TCP"

serviceUrlstring

Example: "0.0.0.0:0"

targetPortstring

Example: "0"

sessionAffinitystring

Session Affinity

Example: "None"

typestring

Service type(ClusterIP, NodePort)

Example: "ClusterIP"

Request

Response

Get cluster namespace DaemonSets list

Get the list of DaemonSets in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/daemonsets

Path parameters

clusterId*string

namespaceName*string

Response

Body

creationTimestampstring

Example: "2023-06-21 06:41:56"

desiredPodCntinteger

Number of pods to provide

Example: 7

imagesarray of string

image list

itemsstring

Example: "101.55.69.30/docker.io/grafana/promtail:2.7.4"

labelsobject

additionalPropstring

namestring

DaemonSet name

Example: "promtail"

namespacestring

namespace name

Example: "cocktail-system"

readyPodCntinteger

Number of ready pods

Example: 7

Request

Response

Get cluster PVC list

Get the list of volume request list of the cluster.

GET/v1/clusters/{clusterId}/persistentvolumeclaims

Path parameters

clusterId*string

Response

Body

accessModesarray of string

Access mode list

itemsstring

Example: "ReadWriteOnce"

annotationsobject

additionalPropstring

capacityobject

additionalPropstring

creationTimestampstring

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

labelsobject

additionalPropstring

namestring

PVC name

Example: "cocktail-api-cmdb-logdata"

namespacestring

namespace name

Example: "cocktail-system"

persistentVolumeTypestring

PVC Type(SINGLE, SHARED)

Example: "SHARED"

statusstring

PVC status

Example: "Bound"

storageClassNamestring

Example: "nfs-csi"

volumeNamestring

Example: "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482"

Request

Response

Get cluster CRD list

Get the CRD list of the cluster.

GET/v1/clusters/{clusterId}/crds

Path parameters

clusterId*string

Response

Body

acceptedNamesAcceptedNames (object)

categoriesarray of string

카테고리 목록 : 사용자 지정 리소스가 속한 그룹화된 리소스 목록

itemsstring

kindstring

리소스 종류(직렬화)

Example: "Gateway"

listKindstring

리소스에 대한 일련의 목록

Example: "GatewayList"

pluralstring

서비스할 리소스의 plural 이름

Example: "gateways"

shortNamesarray of string

리소스의 짧은 이름(모두 소문자)

itemsstring

Example: "gw"

singularstring

리소스의 singular 이름(모두 소문자)

Example: "gateway"

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2022-12-02 08:42:46"

fullNamestring

Example: "gateways.networking.istio.io"

groupstring

group name

Example: "networking.istio.io"

labesobject

additionalPropstring

namestring

resource name

Example: "gateways"

scopestring

resource scope(Cluster, Namespaced)

Example: "Namespaced"

storedVersionstring

Example: "v1alpha3"

versionsarray of object

Version list

namestring

Version name

Example: "v1alpha3"

servedboolean

Availability of the version

storageboolean

Whether to use the version when maintaining user resources in storage

Request

Response

Get cluster nodes list

Get the list of cluster nodes.

GET/v1/clusters/{clusterId}/nodes

Path parameters

clusterId*string

Response

Body

allocatedCpuinteger

Allocated CPU capacity

Example: 48

allocatedEphemeralStorageinteger

Allocated Ephemeral Storage Capacity

Example: 0

allocatedMemoryinteger

Allocated memory capacity

Example: 200903610368

allocatedPodsstring

Allocated number of pods

Example: "110"

cpuCapacityinteger

Example: 48

creationTimestampstring

Example: "2022-12-02 02:33:48"

ephemeralStorageCapacityinteger

Example: 48294789041

gpuCapacityinteger

Example: 2

memoryCapacityinteger

Example: 201008467968

namestring

node name

Example: "apps-gpu-v100"

podCapacityinteger

Example: 110

readystring

ready(True or False)

Example: "True"

Request

Response

Get cluster addon list

Get the list of Addons for that cluster.

GET/v1/clusters/{clusterId}/addons

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2023-06-20 04:08:00"

dataData (object)

additionalPropstring

descriptionstring

Example: ""

labelsobject

additionalPropstring

namestring

ConfigMap name

Example: "addon-manager"

namespacestring

namespace name

Example: "cocktail-addon"

Request

Response

Get cluster namespace StatefulSets list

Get the list of StatefulSets in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/statefulsets

Path parameters

clusterId*string

namespaceName*string

Response

Body

creationTimestampstring

생성 일시

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

desiredPodCntinteger

제공할 파드 수

Example: 1

imagesarray of string

이미지 목록

itemsstring

Example: "101.55.69.30/library/api-cmdb:4.7.4-release.20230413"

labelsobject

라벨

additionalPropstring

namestring

StatefulSet 이름

Example: "cocktail-api-cmdb"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

readyPodCntinteger

준비된 파드 수

Example: 1

Request

Response

Get cluster namespace StatefulSet details

Get detailed information for StatefulSet in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/statefulsets/{statefulSetName}

Path parameters

clusterId*string

namespaceName*string

statefulSetName*string

Response

Body

creationTimestampstring

생성 일시

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

deploymentstring

배포 정보

Example: "{\"apiVersion\":\"apps/v1\",\"kind\":\"StatefulSet\"..."

deploymentYamlstring

배포 정보(YAML)

Example: "apiVersion: apps/v1\nkind: StatefulSet\n..."

desiredPodCntinteger

제공할 파드 수

Example: 1

detailDetail (object)

annotationsobject

어노테이션

additionalPropstring

creationTimestring

생성 일시

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

labelsobject

라벨

additionalPropstring

namestring

StatefulSet 이름

Example: "cocktail-api-cmdb"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

podManagementPolicystring

초기 스케일업 중 노드의 파드 교체할 때 또는 축소할 때 포드 생성 방법 제어

Example: "OrderedReady"

podTemplateobject

파드 템플릿

additionalPropany

replicasinteger

replicas 수

Example: 1

revisionHistoryLimitstring

유지해야 하는 이전 replicaset의 수

Example: "10"

rollingUpdateobject

롤링 업데이트 관련 정보

additionalPropstring

selectorobject

상태 관련 정보

additionalPropstring

statusobject

상태 관련 정보

additionalPropstring

strategyobject

업데이트 Strategy 유형

Example: "RollingUpdate"

volumeClaimTemplatesarray of object

볼륨 claim 템플릿

imagesarray of string

이미지 목록

itemsstring

Example: "101.55.69.30/library/api-cmdb:4.7.4-release.20230413"

labelsobject

라벨

additionalPropstring

namestring

StatefulSet 이름

Example: "cocktail-api-cmdb"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

readyPodCntinteger

준비된 파드 수

Example: 1

Request

Response

Get cluster namespace ingress list

Get the list of Ingresses in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/ingresses

Path parameters

clusterId*string

namespaceName*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2023-01-12 08:33:06"

endpointsarray of string

Endpoint list

itemsstring

ingressControllerNamestring

Example: "nginx"

labelsobject

additionalPropstring

namestring

Ingress name

Example: "api"

namespacestring

Namespace name

Example: "cocktail-system"

Request

Response

Get cluster namespace HAPs list

Get the list of HPA in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/hpas

Path parameters

clusterId*string

namespaceName*string

Response

Body

conditionsarray of Conditions (object)

status information

lastTransitionTimestring

Example: "2023-06-28 05:47:42"

messagestring

Example: "recent recommendations were higher than current one, applying the highest recent recommendation"

reasonstring

Example: "ScaleDownStabilized"

statusstring

status(True or False)

Example: "True"

typestring

Example: "AbleToScale"

creationTimestampstring

Example: "2023-06-14 09:39:07"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"autoscaling/v2\",\"kind\":\"HorizontalPodAutoscaler\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: autoscaling/v2\nkind: HorizontalPodAutoscaler\nmetadata..."

detailDetail (object)

creationTimestring

Example: "2023-06-14 09:38:52"

currentReplicasinteger

Current replicas count

Example: 1

desiredReplicasinteger

Number of replicas to provide

Example: 1

labelsobject

additionalPropstring

lastScaleTimestring

Example: "2023-07-03 06:53:41"

maxReplicasinteger

Maximum replicas count

Example: 3

metricsarray of object

Target metric

additionalPropstring

minReplicasinteger

Minimum replicas count

Example: 2

namestring

Example: "api-server-hpa"

namespacestring

namespace name

Example: "cocktail-system"

targetstring

Example: "Deployment: cocktail-api-server"

maxReplicasinteger

Maximum replicas count

Example: 3

metricsarray of Metrics (object)

Target metric

currentAverageUtilizationinteger

Current value of the average pod resource metric (expressed as a percentage of requested resource values for pods)

Example: 0

currentAverageValuestring

Current value of the average pod metric

Example: "5m"

currentValueinteger

Current value of the metric (quantity)

metricTypestring

metricType(Object, Pods, Resource, External)

Example: "Resource"

namestring

Example: "cpu"

targetAverageUtilizationinteger

Average target value of pod resource metrics (expressed as a percentage of requested resource values for pods)

Example: 70

targetTypestring

Utilization or Value or AverageValue

Example: "Utilization"

minReplicasinteger

Minimum replicas count

Example: 2

namestring

HPA name

Example: "api-server-hpa"

namespacestring

namespace name

Example: "cocktail-system"

scaleTargetRefScaleTargetRef (object)

apiVersionstring

Example: "apps/v1"

kindstring

Example: "Deployment"

namestring

Example: "cocktail-api-server"

startTimestring

Example: "2023-06-28 05:47:26"

Request

Response

Get cluster namespace Container log

Get the logs of Containers in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/pods/{podName}/containers/log

Path parameters

clusterId*string

namespaceName*string

podName*string

Query parameters

type*string

Log Retrieval Method(tail or since)

countstring

The number of lines to read when the type is 'tail' (up to 10,000).

sinceSecondsstring

Return logs from before the value in seconds

Response

Body

containerNamestring

컨테이너 이름

Example: "api-cmdb"

logstring

로그

Example:

"2023-07-03  8:44:55 571828 [Warning] Aborted connection 571828 to db: 'acloud' user: 'root' host: '127.0.0.1' (Got timeout reading communication packets)\n..."

podNamestring

파드 이름

Example: "cocktail-api-cmdb-0"

Request

Response

[
  {
    "creationTimestamp": "2023-04-29 05:54:54",
    "deployment": "{\"apiVersion\":\"apps/v1\",\"kind\":\"StatefulSet\"...",
    "deploymentYaml": "apiVersion: apps/v1\nkind: StatefulSet\n...",
    "desiredPodCnt": 1,
    "detail": {
      "annotations": {
        "acornsoft.io/workload-group-no": "11",
        "meta.helm.sh/release-name": "cocktail",
        "meta.helm.sh/release-namespace": "cocktail-system"
      },
      "creationTime": "2023-04-29 05:54:54",
      "labels": {
        "app.kubernetes.io/instance": "cocktail",
        "app.kubernetes.io/managed-by": "Helm",
        "app.kubernetes.io/name": "api-cmdb"
      },
      "name": "cocktail-api-cmdb",
      "namespace": "cocktail-system",
      "podManagementPolicy": "OrderedReady",
      "podTemplate": {
        "labels": {
          "app": "api-cmdb",
          "app.kubernetes.io/instance": "cocktail",
          "app.kubernetes.io/managed-by": "Helm"
        },
        "spec": {
          "conditions": [],
          "detail": {
            "containers": [
              {
                "args": [
                  "mysqld",
                  "--general-log=1",
                  "--general-log-file=/var/log/mysql/mysql.log"
                ],
                "environmentVariables": {
                  "MYSQL_PASSWORD_FILE": "/temp-secret/COCKTAIL_DB_PASSWORD",
                  "MYSQL_ROOT_PASSWORD_FILE": "/temp-secret/DB_ROOT_PASSWORD",
                  "MYSQL_USER": "{\"key\":\"COCKTAIL_DB_USER\",\"name\":\"cocktail-api-cmdb\"}"
                },
                "image": "101.55.69.30/library/api-cmdb:4.7.4-release.20230413",
                "imagePullPolicy": "Always",
                "name": "api-cmdb",
                "resources": {
                  "cpu": {
                    "limit": "1",
                    "request": "500m"
                  },
                  "memory": {
                    "limit": "2Gi",
                    "request": "1Gi"
                  }
                },
                "restartCount": 0,
                "volumeMounts": {
                  "config": "{\"mountPath\":\"/usr/sbin/ping.sh\",\"name\":\"config\",\"subPath\":\"ping.sh\"}",
                  "log": "{\"mountPath\":\"/var/log/mysql\",\"name\":\"log\",\"subPath\":\"api-cmdb\"}",
                  "log-rotate": "{\"mountPath\":\"/etc/cron.d/mysql-server-crond\",\"name\":\"log-rotate\",\"subPath\":\"mysql-server-crond\"}"
                }
              }
            ],
            "initContainers": [
              {
                "commands": [
                  "/usr/sbin/init_api_cmdb.sh"
                ],
                "image": "101.55.69.30/library/api-cmdb:4.7.4-release.20230413",
                "imagePullPolicy": "Always",
                "name": "init",
                "resources": {
                  "cpu": {
                    "limit": "20m",
                    "request": "20m"
                  },
                  "memory": {
                    "limit": "50Mi",
                    "request": "50Mi"
                  }
                },
                "restartCount": 0,
                "volumeMounts": {
                  "cocktail-secret": "{\"mountPath\":\"/cocktail-secret\",\"name\":\"cocktail-secret\"}",
                  "init": "{\"mountPath\":\"/usr/sbin\",\"name\":\"init\"}",
                  "log": "{\"mountPath\":\"/var/log/mysql\",\"name\":\"log\",\"subPath\":\"api-cmdb\"}",
                  "temp-secret": "{\"mountPath\":\"/temp-secret\",\"name\":\"temp-secret\"}"
                }
              }
            ],
            "restartPolicy": "Always",
            "terminationGracePeriodSeconds": 60
          },
          "podStatus": "Pending",
          "restartCnt": 0
        }
      },
      "replicas": 1,
      "revisionHistoryLimit": "10",
      "rollingUpdate": {
        "partition": 0
      },
      "selector": {
        "matchLabels": {
          "app": "api-cmdb"
        }
      },
      "status": {
        "collisionCount": 0,
        "current": 1,
        "ready": 1,
        "replicas": 1,
        "updated": 1
      },
      "strategy": "RollingUpdate",
      "volumeClaimTemplates": [
        {
          "accessModes": [
            "ReadWriteOnce"
          ],
          "capacity": {
            "storage": "30Gi"
          },
          "name": "mysqldata",
          "storageClassName": "nfs-csi"
        }
      ]
    },
    "images": [
      "101.55.69.30/library/api-cmdb:4.7.4-release.20230413"
    ],
    "labels": {
      "app.kubernetes.io/instance": "cocktail",
      "app.kubernetes.io/managed-by": "Helm",
      "app.kubernetes.io/name": "api-cmdb"
    },
    "name": "cocktail-api-cmdb",
    "namespace": "cocktail-system",
    "readyPodCnt": 1
  }
]

[
  {
    "conditions": [
      {
        "lastTransitionTime": "2023-06-28 05:47:42",
        "message": "recent recommendations were higher than current one, applying the highest recent recommendation",
        "reason": "ScaleDownStabilized",
        "status": "True",
        "type": "AbleToScale"
      }
    ],
    "creationTimestamp": "2023-06-14 09:39:07",
    "deployment": "{\"apiVersion\":\"autoscaling/v2\",\"kind\":\"HorizontalPodAutoscaler\"...",
    "deploymentYaml": "apiVersion: autoscaling/v2\nkind: HorizontalPodAutoscaler\nmetadata...",
    "detail": {
      "creationTime": "2023-06-14 09:38:52",
      "currentReplicas": 1,
      "desiredReplicas": 1,
      "labels": {
        "app": "api-server-hpa"
      },
      "lastScaleTime": "2023-07-03 06:53:41",
      "maxReplicas": 3,
      "metrics": [
        {
          "currentAverageUtilization": 0,
          "currentAverageValue": "5m",
          "currentValue": "0",
          "metricType": "Resource",
          "name": "cpu",
          "targetAverageUtilization": 70,
          "targetType": "Utilization"
        }
      ],
      "minReplicas": 2,
      "name": "api-server-hpa",
      "namespace": "cocktail-system",
      "target": "Deployment: cocktail-api-server"
    },
    "maxReplicas": 3,
    "metrics": [
      {
        "currentAverageUtilization": 0,
        "currentAverageValue": "5m",
        "metricType": "Resource",
        "name": "cpu",
        "targetAverageUtilization": 70,
        "targetType": "Utilization"
      }
    ],
    "minReplicas": 2,
    "name": "api-server-hpa",
    "namespace": "cocktail-system",
    "scaleTargetRef": {
      "apiVersion": "apps/v1",
      "kind": "Deployment",
      "name": "cocktail-api-server"
    },
    "startTime": "2023-06-28 05:47:26"
  }
]

Get cluster namespace Cronjobs list

Get the list of CronJobs in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/cronjobs

Path parameters

clusterId*string

namespaceName*string

Response

Body

activeJobCntinteger

active job count

Example: 1

creationTimestampstring

Example: "2023-06-14 09:30:39"

imagesarray of string

Image list

itemsstring

Example: "nginx:latest"

labelsobject

additionalPropstring

lastScheduleTimestring

Example: "2023-06-14 09:31:00"

namestring

CronJob name

Example: "cronjob"

namespacestring

namespace name

Example: "cocktail-system"

schedulestring

Example: "* * * * *"

suspendboolean

Example: false

Request

Response

Get cluster ingress list

Get the ingress list of the cluster.

GET/v1/clusters/{clusterId}/ingresses

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

creationTimestampstring

Example: "2023-01-12 08:33:06"

endpointsarray of string

Endpoint list

itemsstring

ingressControllerNamestring

Example: "nginx"

labesobject

additionalPropstring

namestring

ingress name

Example: "api"

namespacestring

namespace name

Example: "cocktail-system"

Request

Response

Get cluster namespace Cronjob details

Get detailed information for CronJob in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/cronjobs/{cronJobName}

Path parameters

clusterId*string

namespaceName*string

cronJobName*string

Response

Body

activeJobCntinteger

active job count

Example: 1

creationTimestampstring

Example: "2023-06-14 09:30:39"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"batch/v1\",\"kind\":\"CronJob\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: batch/v1\nkind: CronJob\nmetadata:\n..."

detailDetail (object)

activeJobsarray of object

active job count

additionalPropany

annotationsobject

additionalPropstring

backoffLimitinteger

Number of retry attempts if the job fails

Example: 3

completionsinteger

Completion count

Example: 1

concurrencyPolicystring

Concurrency polic(Allow, Forbid, Replace)

Example: "Allow"

creationTimestampstring

Example: "2023-06-14 09:30:39"

failedJobsHistoryLimitinteger

Number of job failure records

Example: 1

labelsobject

additionalPropstring

lastScheduleTimestring

Example: "2023-07-04 06:38:00"

namestring

CronJob name

Example: "cronjob"

namespacestring

namespace name

Example: "cocktail-system"

parallelisminteger

parallelism

Example: 1

podTemplateobject

additionalPropany

schedulestring

Example: "* * * * *"

successfulJobsHistoryLimitinteger

Specify the number of successful job records

Example: 3

suspendboolean

Example: false

imagesarray of string

Image list

itemsstring

Example: "nginx:latest"

labelsobject

additionalPropstring

lastScheduleTimestring

Example: "2023-07-04 06:38:00"

namestring

CronJob name

Example: "cronjob"

namespacestring

namespace name

Example: "cocktail-system"

schedulestring

Example: "* * * * *"

suspendboolean

Example: false

Request

Response

Get cluster namespace ReplicaSets list

Get the list of ReplicaSets in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/replicaset

Path parameters

clusterId*string

namespaceName*string

Response

Body

creationTimestampstring

생성 일시

Example: "2023-06-28 08:10:52"

desiredPodCntinteger

제공할 파드 수

Example: 1

imagesarray of string

이미지 목록

itemsstring

Example: "regi.acloud.run/library/log-api:1.3.0"

labelsobject

라벨

additionalPropstring

namestring

ReplicaSet 이름

Example: "cocktail-log-api-9d5bcff4"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

ownerReferencesarray of OwnerReferences (object)

소유자 참조 목록

apiVersionstring

API 버전

Example: "apps/v1"

blockOwnerDeletionboolean

소유자 오브젝트 삭제 차단 여부

controllerboolean

컨트롤러 사용 여부

kindstring

유형

Example: "Deployment"

namestring

ReplicaSet 이름

Example: "cocktail-log-api"

uidstring

uid

Example: "85f52a56-52e7-4289-8777-25f8c78d60e5"

readyPodCntinteger

준비된 파드 수

Example: 1

Request

Response

[
  {
    "activeJobCnt": 1,
    "creationTimestamp": "2023-06-14 09:30:39",
    "deployment": "{\"apiVersion\":\"batch/v1\",\"kind\":\"CronJob\"...",
    "deploymentYaml": "apiVersion: batch/v1\nkind: CronJob\nmetadata:\n...",
    "detail": {
      "activeJobs": [
        {
          "completionPodCnt": 0,
          "creationTimestamp": "2023-07-04 06:38:00",
          "deployment": "{\"apiVersion\":\"batch/v1\",\"kind\":\"Job\",\"metadata\"",
          "deploymentYaml": "apiVersion: batch/v1\nkind: Job\nmetadata:\n",
          "desiredPodCnt": 1,
          "detail": {
            "annotations": {
              "sidecar.istio.io/inject": "false"
            },
            "backoffLimit": 6,
            "completions": 1,
            "creationTime": "2023-07-04 06:38:00",
            "labels": {
              "app": "cronjob"
            },
            "name": "cronjob-28140878",
            "namespace": "cocktail-system",
            "ownerReferences": [
              {
                "apiVersion": "batch/v1",
                "blockOwnerDeletion": true,
                "controller": true,
                "kind": "CronJob",
                "name": "cronjob",
                "uid": "c86a8fcc-7ecc-4445-a72f-cb272b7074a9"
              }
            ],
            "parallelism": 1,
            "podTemplate": {
              "annotations": {
                "cocktail-deploy-datetime": "2023-06-14 01:21:02.598",
                "kubectl.kubernetes.io/restartedAt": "2023-06-14T01:28:04Z"
              },
              "labels": {
                "app": "cronjob",
                "controller-uid": "ba7b126d-b790-4152-a77e-b410da5f4fd7",
                "job-name": "cronjob-28140878"
              },
              "spec": {
                "conditions": [],
                "detail": {
                  "containers": [
                    {
                      "image": "nginx:latest",
                      "imagePullPolicy": "Always",
                      "name": "nginx",
                      "resources": {
                        "cpu": {
                          "limit": "200m",
                          "request": "100m"
                        },
                        "memory": {
                          "limit": "209715200",
                          "request": "104857600"
                        }
                      },
                      "restartCount": 0,
                      "volumeMounts": {
                        "a": "{\"mountPath\":\"/data\",\"name\":\"a\"}",
                        "b": "{\"mountPath\":\"/data2\",\"name\":\"b\"}",
                        "c": "{\"mountPath\":\"/data3\",\"name\":\"c\"}"
                      }
                    }
                  ],
                  "initContainers": [],
                  "restartPolicy": "OnFailure",
                  "terminationGracePeriodSeconds": 30
                },
                "podStatus": "Pending",
                "restartCnt": 0
              }
            },
            "selector": {
              "matchLabels": {
                "controller-uid": "ba7b126d-b790-4152-a77e-b410da5f4fd7"
              }
            },
            "status": {
              "Failed": 0,
              "Running": 1,
              "Succeeded": 0
            }
          },
          "images": [
            "nginx:latest"
          ],
          "labels": {
            "app": "cronjob"
          },
          "name": "cronjob-28140878",
          "namespace": "cocktail-system"
        }
      ],
      "annotations": {
        "acornsoft.io/workload-group-no": "53",
        "cocktail-deploy-datetime": "2023-06-14 09:30:39.002",
        "cocktail-user-description": "Lg=="
      },
      "backoffLimit": 3,
      "completions": 1,
      "concurrencyPolicy": "Allow",
      "creationTimestamp": "2023-06-14 09:30:39",
      "failedJobsHistoryLimit": 1,
      "labels": {
        "app": "cronjob"
      },
      "lastScheduleTime": "2023-07-04 06:38:00",
      "name": "cronjob",
      "namespace": "cocktail-system",
      "parallelism": 1,
      "podTemplate": {
        "annotations": {
          "cocktail-deploy-datetime": "2023-06-14 01:21:02.598",
          "kubectl.kubernetes.io/restartedAt": "2023-06-14T01:28:04Z"
        },
        "labels": {
          "app": "test2"
        },
        "spec": {
          "conditions": [],
          "detail": {
            "containers": [
              {
                "image": "nginx:latest",
                "imagePullPolicy": "Always",
                "name": "nginx",
                "resources": {
                  "cpu": {
                    "limit": "200m",
                    "request": "100m"
                  },
                  "memory": {
                    "limit": "209715200",
                    "request": "104857600"
                  }
                },
                "restartCount": 0,
                "volumeMounts": {
                  "a": "{\"mountPath\":\"/data\",\"name\":\"a\"}",
                  "b": "{\"mountPath\":\"/data2\",\"name\":\"b\"}",
                  "c": "{\"mountPath\":\"/data3\",\"name\":\"c\"}"
                }
              }
            ],
            "initContainers": [],
            "restartPolicy": "OnFailure",
            "terminationGracePeriodSeconds": 30
          },
          "podStatus": "Pending",
          "restartCnt": 0
        }
      },
      "schedule": "* * * * *",
      "successfulJobsHistoryLimit": 3,
      "suspend": false
    },
    "images": [
      "nginx:latest"
    ],
    "labels": {
      "app": "cronjob"
    },
    "lastScheduleTime": "2023-07-04 06:38:00",
    "name": "cronjob",
    "namespace": "cocktail-system",
    "schedule": "* * * * *",
    "suspend": false
  }
]

Get cluster namespace Deployment details

Get detailed information for Deployment in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/deployments/{deploymentName}

Path parameters

clusterId*string

namespaceName*string

deploymentName*string

Response

Body

conditionsarray of Conditions (object)

status information

lastHeartbeatTimestring

Last measurement time

Example: "2023-05-02 07:12:02"

lastTransitionTimestring

Example: "2023-05-02 07:12:02"

messagestring

Example: "Deployment has minimum availability."

reasonstring

Example: "MinimumReplicasAvailable"

statusstring

status(True or False)

Example: "True"

typestring

Example: "Available"

creationTimestampstring

Example: "2023-05-02 07:12:02"

deploymentstring

deployment information

Example: "{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\"..."

deploymentYamlstring

deployment information(YAML)

Example: "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n..."

desiredPodCntinteger

Number of pods to provide

Example: 1

detailDetail (object)

annotationsobject

additionalPropstring

creationTimestring

Example: "2023-05-02 01:45:53"

labelsobject

additionalPropstring

minReadySecondsinteger

Minimum time to be ready

Example: 0

namestring

Deployement name

Example: "cocktail-log-api"

namespacestring

namespace name

Example: "cocktail-system"

podTemplateobject

additionalPropany

replicasinteger

replicas count

Example: 1

revisionHistoryLimitstring

Number of previous replicaset to maintain

Example: "10"

rollingUpdateobject

Rolling update-related information

additionalPropstring

selectorobject

State-related information

additionalPropstring

statusobject

State-related information

additionalPropstring

strategyobject

Status

Example: "RollingUpdate"

imagesarray of string

Image list

itemsstring

Example: "regi.acloud.run/library/log-api:1.3.0"

labelsobject

additionalPropstring

matchLabelsobject

match Label list

additionalPropstring

namestring

Deployement name

Example: "cocktail-log-api"

namespacestring

namespace name

Example: "cocktail-system"

newReplicaSetsarray of NewReplicaSets (object)

New replicaset information

creationTimestampstring

Example: "2023-06-28 08:10:52"

deploymentstring

ReplicaSet deployment information

Example: "{\"metadata\":{\"annotations\":{\"acornsoft.io/workload-group-no\":\"12\",\"cocktail-deploy-datetime..."

deploymentYamlstring

ReplicaSet deployment information(YAML)

Example: "metadata:\n annotations:\n acornsoft.io/workload-group-no: '12'\n cocktail-deploy-datetime..."

desiredPodCntinteger

Number of Pods to provide

Example: 1

detailobject

ReplicaSet Detailed information

additionalPropany

imagesarray of string

Image list

itemsstring

Example: "regi.acloud.run/library/log-api:1.3.0"

labelsobject

additionalPropstring

namestring

ReplicaSet name

Example: "cocktail-log-api-9d5bcff4"

namespacestring

namespace name

Example: "cocktail-system"

readyPodCntinteger

Number of ready Pods

Example: 1

readyPodCntinteger

Number of ready pods

Example: 1

Request

Response

[
  {
    "conditions": [
      {
        "lastHeartbeatTime": "2023-05-02 07:12:02",
        "lastTransitionTime": "2023-05-02 07:12:02",
        "message": "Deployment has minimum availability.",
        "reason": "MinimumReplicasAvailable",
        "status": "True",
        "type": "Available"
      }
    ],
    "creationTimestamp": "2023-05-02 07:12:02",
    "deployment": "{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\"...",
    "deploymentYaml": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n...",
    "desiredPodCnt": 1,
    "detail": {
      "annotations": {
        "acornsoft.io/workload-group-no": "12",
        "cocktail-deploy-datetime": "2023-06-28 08:10:52.898",
        "cocktail-user-description": ""
      },
      "creationTime": "2023-05-02 01:45:53",
      "labels": {
        "app": "api",
        "app.kubernetes.io/managed-by": "Helm",
        "chart": "api-1.0.0"
      },
      "minReadySeconds": 0,
      "name": "cocktail-log-api",
      "namespace": "cocktail-system",
      "podTemplate": {
        "annotations": {
          "kubectl.kubernetes.io/restartedAt": "2023-06-28T08:10:52Z"
        },
        "labels": {
          "app.kubernetes.io/app": "cocktail-log-api",
          "app.kubernetes.io/instance": "cocktail-log",
          "app.kubernetes.io/name": "api",
          "chart": "api-1.0.0",
          "heritage": "Helm"
        },
        "spec": {
          "conditions": [],
          "detail": {
            "containers": [
              {
                "environmentVariables": {
                  "APPLICATION_SCRAPE_JOB": "{\"key\":\"APPLICATION_SCRAPE_JOB\",\"name\":\"cocktail-log-api\"}",
                  "AUDIT_SCRAPE_JOB": "{\"key\":\"AUDIT_SCRAPE_JOB\",\"name\":\"cocktail-log-api\"}",
                  "COCKTAIL_API_SERVER": "http://api-server:8080",
                  "CONTAINER_SCRAPE_JOB": "{\"key\":\"CONTAINER_SCRAPE_JOB\",\"name\":\"cocktail-log-api\"}",
                  "LOGGING_FILE_PATH": "/var/log/app/monitoring.log",
                  "LOGGING_FILE_USE": "true",
                  "LOGGING_LEVEL": "debug",
                  "LOKI_ENABLED": "true",
                  "LOKI_SERVER_URL": "http://cocktail-logs-loki-distributed-gateway.cocktail-apm",
                  "SERVICE_PORT": "9100"
                },
                "image": "regi.acloud.run/library/log-api:1.3.0",
                "imagePullPolicy": "Always",
                "name": "api",
                "resources": {
                  "cpu": {
                    "limit": "5",
                    "request": "100m"
                  },
                  "memory": {
                    "limit": "5242880k",
                    "request": "134217728"
                  }
                },
                "restartCount": 0,
                "volumeMounts": {
                  "app-volume": "{\"mountPath\":\"/var/log/app\",\"name\":\"app-volume\",\"subPath\":\"cocktail-log-api\"}",
                  "loki-cert": "{\"mountPath\":\"/etc/loki/cert\",\"name\":\"loki-cert\"}"
                }
              }
            ],
            "imagePullSecrets": [
              {
                "name": "devops-cocktail-t4f1hevxvkmv"
              }
            ],
            "initContainers": [],
            "restartPolicy": "Always",
            "terminationGracePeriodSeconds": 30
          },
          "podStatus": "Pending",
          "restartCnt": 0
        }
      },
      "replicas": 1,
      "revisionHistoryLimit": "10",
      "rollingUpdate": {
        "maxSurge": "25%",
        "maxUnavailable": "25%"
      },
      "selector": {
        "matchLabels": {
          "app.kubernetes.io/app": "cocktail-log-api",
          "app.kubernetes.io/instance": "cocktail-log",
          "app.kubernetes.io/name": "api"
        }
      },
      "status": {
        "available": 1,
        "total": 1,
        "unavailable": 0,
        "updated": 1
      },
      "strategy": "RollingUpdate"
    },
    "images": [
      "regi.acloud.run/library/log-api:1.3.0"
    ],
    "labels": {
      "app": "api",
      "app.kubernetes.io/managed-by": "Helm",
      "chart": "api-1.0.0"
    },
    "matchLabels": {
      "app.kubernetes.io/app": "cocktail-log-api",
      "app.kubernetes.io/instance": "cocktail-log",
      "app.kubernetes.io/name": "api"
    },
    "name": "cocktail-log-api",
    "namespace": "cocktail-system",
    "newReplicaSets": [
      {
        "creationTimestamp": "2023-06-28 08:10:52",
        "deployment": "{\"metadata\":{\"annotations\":{\"acornsoft.io/workload-group-no\":\"12\",\"cocktail-deploy-datetime...",
        "deploymentYaml": "metadata:\n  annotations:\n    acornsoft.io/workload-group-no: '12'\n    cocktail-deploy-datetime...",
        "desiredPodCnt": 1,
        "detail": {
          "annotations": {
            "acornsoft.io/workload-group-no": "12",
            "cocktail-deploy-datetime": "2023-06-28 08:10:52.898",
            "cocktail-user-description": "",
            "deployment.kubernetes.io/desired-replicas": "1",
            "deployment.kubernetes.io/max-replicas": "2",
            "deployment.kubernetes.io/revision": "88",
            "meta.helm.sh/release-name": "cocktail-log",
            "meta.helm.sh/release-namespace": "cocktail-system"
          },
          "creationTime": "2023-06-28 08:10:52",
          "images": [
            "regi.acloud.run/library/log-api:1.3.0"
          ],
          "labels": {
            "app.kubernetes.io/app": "cocktail-log-api",
            "app.kubernetes.io/instance": "cocktail-log",
            "app.kubernetes.io/name": "api",
            "chart": "api-1.0.0",
            "heritage": "Helm",
            "pod-template-hash": "9d5bcff4"
          },
          "name": "cocktail-log-api-9d5bcff4",
          "namespace": "cocktail-system",
          "ownerReferences": [
            {
              "apiVersion": "apps/v1",
              "blockOwnerDeletion": true,
              "controller": true,
              "kind": "Deployment",
              "name": "cocktail-log-api",
              "uid": "85f52a56-52e7-4289-8777-25f8c78d60e5"
            }
          ],
          "podTemplate": {
            "annotations": {
              "kubectl.kubernetes.io/restartedAt": "2023-06-28T08:10:52Z"
            },
            "labels": {
              "app.kubernetes.io/app": "cocktail-log-api",
              "app.kubernetes.io/instance": "cocktail-log",
              "app.kubernetes.io/name": "api",
              "chart": "api-1.0.0",
              "heritage": "Helm",
              "pod-template-hash": "9d5bcff4"
            },
            "spec": {
              "conditions": [],
              "detail": {
                "containers": [
                  {
                    "environmentVariables": {
                      "APPLICATION_SCRAPE_JOB": "{\"key\":\"APPLICATION_SCRAPE_JOB\",\"name\":\"cocktail-log-api\"}",
                      "AUDIT_SCRAPE_JOB": "{\"key\":\"AUDIT_SCRAPE_JOB\",\"name\":\"cocktail-log-api\"}",
                      "COCKTAIL_API_SERVER": "http://api-server:8080",
                      "CONTAINER_SCRAPE_JOB": "{\"key\":\"CONTAINER_SCRAPE_JOB\",\"name\":\"cocktail-log-api\"}",
                      "LOGGING_FILE_PATH": "/var/log/app/monitoring.log",
                      "LOGGING_FILE_USE": "true",
                      "LOGGING_LEVEL": "debug",
                      "LOKI_ENABLED": "true",
                      "LOKI_SERVER_URL": "http://cocktail-logs-loki-distributed-gateway.cocktail-apm",
                      "SERVICE_PORT": "9100"
                    },
                    "image": "regi.acloud.run/library/log-api:1.3.0",
                    "imagePullPolicy": "Always",
                    "name": "api",
                    "resources": {
                      "cpu": {
                        "limit": "5",
                        "request": "100m"
                      },
                      "memory": {
                        "limit": "5242880k",
                        "request": "134217728"
                      }
                    },
                    "restartCount": 0,
                    "volumeMounts": {
                      "app-volume": "{\"mountPath\":\"/var/log/app\",\"name\":\"app-volume\",\"subPath\":\"cocktail-log-api\"}",
                      "loki-cert": "{\"mountPath\":\"/etc/loki/cert\",\"name\":\"loki-cert\"}"
                    }
                  }
                ],
                "imagePullSecrets": [
                  {
                    "name": "devops-cocktail-t4f1hevxvkmv"
                  }
                ],
                "initContainers": [],
                "restartPolicy": "Always",
                "terminationGracePeriodSeconds": 30
              },
              "podStatus": "Pending",
              "restartCnt": 0
            }
          },
          "pods": {
            "running": 1
          },
          "podsStatus": {},
          "selector": {
            "matchLabels": {
              "app.kubernetes.io/app": "cocktail-log-api",
              "app.kubernetes.io/instance": "cocktail-log",
              "app.kubernetes.io/name": "api",
              "heritage": "Helm",
              "pod-template-hash": "9d5bcff4"
            }
          }
        },
        "images": [
          "regi.acloud.run/library/log-api:1.3.0"
        ],
        "labels": {
          "app.kubernetes.io/app": "cocktail-log-api",
          "app.kubernetes.io/instance": "cocktail-log",
          "app.kubernetes.io/name": "api"
        },
        "name": "cocktail-log-api-9d5bcff4",
        "namespace": "cocktail-system",
        "readyPodCnt": 1
      }
    ],
    "readyPodCnt": 1
  }
]

Get cluster namespace pods logs

Get the list of Pods in the specified cluster and namespace..

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/pods

Path parameters

clusterId*string

namespaceName*string

Response

Body

conditionsarray of Conditions (object)

상태 정보

lastTransitionTimestring

마지막 전송 시각

Example: "22023-05-01 09:20:19"

statusstring

True or False

Example: "True"

typestring

유형

Example: "Initialized"

detailDetail (object)

annotationsobject

어노테이션

additionalPropstring

containersarray of object

컨테이너 정보

additionalPropany

creationTimestampstring

생성 일시

Example: "2023-05-01 09:20:09"

hostnamestring

호스트 이름

Example: "cocktail-api-cmdb-0"

initContainersarray of object

additionalPropany

labelsobject

라벨

additionalPropstring

namespacestring

네임스페이스 이름

Example: "cocktail-system"

nodeNamestring

네임스페이스 이름

Example: "apps-gpu-v100"

ownerReferencesarray of object

참조 정보

additionalPropstring

podIPstring

파드 IP

Example: "0.0.0.0"

podNamestring

파드 이름

Example: "cocktail-api-cmdb-0"

podStatusstring

파드 상태

Example: "Running"

qosClassstring

QoS 클래스

Example: "Burstable"

restartPolicystring

재시작 정책

Example: "Always"

serviceAccountNamestring

서비스 계정 이름

Example: "default"

startTimestring

시작 시각

Example: "2023-05-01 09:20:09"

terminationGracePeriodSecondsinteger

종료 시 유예 시간

Example: 60

tolerationsarray of object

toleration 정보 목록

additionalPropstring

namespacestring

네임스페이스 이름

Example: "cocktail-system"

nodeNamestring

노드 이름

Example: "apps-gpu-v100"

podNamestring

파드 이름

Example: "cocktail-api-cmdb-0"

podStatusstring

파드 상태

Example: "Running"

restartCntinteger

재시작 파드 수

Example: 0

startTimestring

시작 시각

Example: "2023-05-01 09:20:09"

Request

Response

Get cluster package list

Get the list of packages in the cluster.

GET/v1/clusters/{clusterId}/packages

Path parameters

clusterId*string

Response

Body

appVersionstring

Example: "4.7.3"

chartNamestring

Example: "cocktail"

chartVersionstring

Example: "4.7.4"

infoInfo (object)

deletedstring

Deletion time

Example: "0001-01-01 00:00:00 +0000 UTC"

descriptionstring

Example: ""

firstDeployedstring

First deployment datetime

Example: "2023-04-29 05:54:50.086853557 +0000 UTC"

iconstring

Example: ""

lastDeployedstring

Last deployment datetime

Example: "2023-04-29 06:04:37.924985116 +0000 UTC"

notesstring

Example: ""

readmestring

Read Me

Example: ""

statusstring

Example: "deployed"

namestring

Package name

Example: "cocktail"

namespacestring

Namespace name

Example: "cocktail-system"

revisionstring

Example: "2"

Request

Response

[
  {
    "conditions": [
      {
        "lastTransitionTime": "22023-05-01 09:20:19",
        "status": "True",
        "type": "Initialized"
      }
    ],
    "detail": {
      "annotations": {
        "cni.projectcalico.org/containerID": "2869a9d6ccd7a53fc8fdccda05168581a99115ffacd7beb834d816e2ab2ee6e7",
        "cni.projectcalico.org/podIP": "0.0.0.0/0",
        "cni.projectcalico.org/podIPs": "0.0.0.0/0"
      },
      "containers": [
        {
          "args": [
            "mysqld",
            "--general-log=1",
            "--general-log-file=/var/log/mysql/mysql.log",
            "--slow-query-log=1",
            "--slow-query-log-file=/var/log/mysql/mysql-slow.log"
          ],
          "containerID": "containerd://6b87d5769493be45af8a48e97f5bab7ae7cfe8cc4e39d7d2b15ebda3a79da2eb",
          "environmentVariables": {
            "MYSQL_PASSWORD_FILE": "/temp-secret/COCKTAIL_DB_PASSWORD",
            "MYSQL_ROOT_PASSWORD_FILE": "/temp-secret/DB_ROOT_PASSWORD",
            "MYSQL_USER": "{\"key\":\"COCKTAIL_DB_USER\",\"name\":\"cocktail-api-cmdb\"}"
          },
          "image": "101.55.69.30/library/api-cmdb:4.7.4-release.20230413",
          "imageID": "101.55.69.30/library/api-cmdb@sha256:30eea53896de7b26d9f9e8e6903d3706ddbe77ceda5b2bb6807f1da10e231c63",
          "imagePullPolicy": "Always",
          "lastState": "{}",
          "name": "api-cmdb",
          "ready": true,
          "resources": {
            "cpu": {
              "limit": "1",
              "request": "500m"
            },
            "memory": {
              "limit": "2Gi",
              "request": "1Gi"
            }
          },
          "restartCount": 0,
          "startTime": "2023-05-01 09:20:19",
          "state": "{\"running\":{\"startedAt\":\"2023-05-01T09:20:19.000000Z\"}}",
          "volumeMounts": {
            "config": "{\"mountPath\":\"/usr/sbin/ping.sh\",\"name\":\"config\",\"subPath\":\"ping.sh\"}",
            "kube-api-access-cts42": "{\"mountPath\":\"/var/run/secrets/kubernetes.io/serviceaccount\",\"name\":\"kube-api-access-cts42\",\"readOnly\":true}",
            "log": "{\"mountPath\":\"/var/log/mysql\",\"name\":\"log\",\"subPath\":\"api-cmdb\"}",
            "log-rotate": "{\"mountPath\":\"/etc/cron.d/mysql-server-crond\",\"name\":\"log-rotate\",\"subPath\":\"mysql-server-crond\"}",
            "mysqldata": "{\"mountPath\":\"/var/lib/mysql/\",\"name\":\"mysqldata\",\"subPath\":\"data\"}",
            "temp-secret": "{\"mountPath\":\"/temp-secret\",\"name\":\"temp-secret\"}"
          }
        }
      ],
      "creationTimestamp": "2023-05-01 09:20:09",
      "hostname": "cocktail-api-cmdb-0",
      "initContainers": [
        {
          "commands": [
            "/usr/sbin/init_api_cmdb.sh"
          ],
          "containerID": "containerd://9e5d154acc5e85e9db8b829266afe37c2c36a3e0b707187f0905e98769eab07f",
          "image": "101.55.69.30/library/api-cmdb:4.7.4-release.20230413",
          "imageID": "101.55.69.30/library/api-cmdb@sha256:30eea53896de7b26d9f9e8e6903d3706ddbe77ceda5b2bb6807f1da10e231c63",
          "imagePullPolicy": "Always",
          "lastState": "{}",
          "name": "init",
          "ready": true,
          "resources": {
            "cpu": {
              "limit": "20m",
              "request": "20m"
            },
            "memory": {
              "limit": "50Mi",
              "request": "50Mi"
            }
          },
          "restartCount": 0,
          "startTime": "2023-05-01 09:20:16",
          "state": "{\"terminated\":{\"containerID\":\"containerd://9e5d154acc5e85e9db8b829266afe37c2c36a3e0b707187f0905e98769eab07f\",\"exitCode\":0,\"finishedAt\":\"2023-05-01T09:20:18.000000Z\",\"reason\":\"Completed\",\"startedAt\":\"2023-05-01T09:20:16.000000Z\"}}",
          "volumeMounts": {
            "cocktail-secret": "{\"mountPath\":\"/cocktail-secret\",\"name\":\"cocktail-secret\"}",
            "init": "{\"mountPath\":\"/usr/sbin\",\"name\":\"init\"}",
            "kube-api-access-cts42": "{\"mountPath\":\"/var/run/secrets/kubernetes.io/serviceaccount\",\"name\":\"kube-api-access-cts42\",\"readOnly\":true}",
            "log": "{\"mountPath\":\"/var/log/mysql\",\"name\":\"log\",\"subPath\":\"api-cmdb\"}",
            "temp-secret": "{\"mountPath\":\"/temp-secret\",\"name\":\"temp-secret\"}"
          }
        }
      ],
      "labels": {
        "app": "api-cmdb",
        "app.kubernetes.io/instance": "cocktail",
        "app.kubernetes.io/managed-by": "Helm"
      },
      "namespace": "cocktail-system",
      "nodeName": "apps-gpu-v100",
      "ownerReferences": [
        {
          "apiVersion": "apps/v1",
          "blockOwnerDeletion": true,
          "controller": true,
          "kind": "StatefulSet",
          "name": "cocktail-api-cmdb",
          "uid": "cd832df7-397a-4f17-9e38-0fc0f3f5baa0"
        }
      ],
      "podIP": "0.0.0.0",
      "podName": "cocktail-api-cmdb-0",
      "podStatus": "Running",
      "qosClass": "Burstable",
      "restartPolicy": "Always",
      "serviceAccountName": "default",
      "startTime": "2023-05-01 09:20:09",
      "terminationGracePeriodSeconds": 60,
      "tolerations": [
        {
          "effect": "NoExecute",
          "key": "node.kubernetes.io/not-ready",
          "operator": "Exists",
          "tolerationSeconds": 30
        }
      ]
    },
    "namespace": "cocktail-system",
    "nodeName": "apps-gpu-v100",
    "podName": "cocktail-api-cmdb-0",
    "podStatus": "Running",
    "restartCnt": 0,
    "startTime": "2023-05-01 09:20:09"
  }
]

Get cluster namespace Jobs list

Get the list of Jobs in the specified cluster and namespace.

GET/v1/clusters/{clusterId}/namespaces/{namespaceName}/jobs

Path parameters

clusterId*string

namespaceName*string

Response

Body

completionPodCntinteger

완료된 파드 수

Example: 1

creationTimestampstring

생성 일시

Example: "2023-05-15 09:45:06"

desiredPodCntinteger

제공할 파드 수

Example: 1

imagesarray of string

이미지 목록

itemsstring

Example: "docker.io/k8ssandra/k8ssandra-tools:latest"

labelsobject

라벨

additionalPropstring

namestring

Job 이름

Example: "k8ssandra-operator-crd-upgrader-job-k8ssandra"

namespacestring

네임스페이스 이름

Example: "cocktail-system"

Request

Response

Get cluster namespace service exposure list

Get the list of exposed services in the specified cluster and namespace.

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

Path parameters

clusterId*string

namespaceName*string

Response

Body

annotationsobject

additionalPropstring

clusterIPstring

Example: "0.0.0.0"

creationTimestampstring

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

internalLBFlagboolean

Internal load balancer availability

Example: false

labelsobject

additionalPropstring

namespacestring

Namespace name

Example: "cocktail-system"

serviceNamestring

Example: "api-cmdb"

servicePortsServicePorts (object)

portstring

Example: "0"

protocolstring

Example: "TCP"

serviceUrlstring

Example: "10.187.158.194:3306"

targetPortstring

Example: "3306"

sessionAffinitystring

Session Affinity

Example: "None"

typestring

Example: "ClusterIP"

Request

Response

Get cluster storage list

Get the storage list of the cluster.

GET/v1/clusters/{clusterId}/storages

Path parameters

clusterId*string

Response

Body

annotationsobject

additionalPropstring

baseStorageYnstring

Default storage availability (Y: Allowed, N: Not allowed)

Example: "Y"

descriptionstring

Example: ""

labelsobject

additionalPropstring

mountOptionsarray of string

List of mount options

itemsstring

namestring

Storage name

Example: "nfs-csi"

parametersarray of object

Parameter list

namestring

Parameter name

valuestring

Parameter value

phasestring

Volume status (Only used in Static Volume)(UNKNOWN, AVAILABLE, BOUND, RELEASED, FAILED, DELETED)

Example: "AVAILABLE"

pluginstring

Example: "NFS_CSI"

provisionerNamestring

Example: "nfs.csi.k8s.io"

readOnlyManyYnstring

Volume request ReadOnlyMany support availability(Y: Allowed, N: Not allowed)

Example: "Y"

readWriteManyYnstring

Volume request ReadWriteMany support availability(Y : Allowed, N: Not allowed)

Example: "Y"

readWriteOnceYnstring

Volume request readWriteOnceYn support availability(Y : Allowed, N: Not allowed)

Example: "Y"

reclaimPolicystring

reclaimPolicy(RECYCLE, RETAIN, DELETE, RECYCLE, RETAIN, DELETE)

Example: "RETAIN"

storageTypestring

storageType(BLOCK, NETWORK, BLOCK, NETWORK)

Example: "NETWORK"

totalCapacityinteger

Example: 1024

typestring

Configuration type(None, HOST_PATH, EMPTY_DIR, CONFIG_MAP, SECRET, PERSISTENT_VOLUME_STATIC, PERSISTENT_VOLUME_LINKED, PERSISTENT_VOLUME)

Example: "PERSISTENT_VOLUME"

volumeBindingModestring

volumeBindingMode(IMMEDIATE, WAIT_FOR_FIRST_CONSUMER, IMMEDIATE, WAIT_FOR_FIRST_CONSUMER)

Example: "IMMEDIATE"

Request

Response