1 of 100

OpenAPI - R4.8.1 - EN

What is Cocktail Open API?

Cocktail Open API is a management service for external access to the Cocktail service API, including features such as user authentication, restrictions, and statistics

Introduction

This document explains all available API calls and the properties of the returned objects

Getting Started

The operation of API authentication tokens

This is how the Gateway and Cocktail API operate using JWT tokens

Anyone with the API token can use the Cocktail API.

Be careful not to expose the token!

API INFORMATION

API Token Issuance

Issue Token

Access [External APIs] - [APIs], then click on the "Issued" button.

Fill in the [Issue Token] window, fill in the required information, and then click the "Save" button.

The information to be filled in is as follows

Items(*is required)

Content

Name*

Token name (non-editable)

Description

Description of the token

Expiration Date

Indefinite or specific date designation

Allow IP

- List of allowed IP addresses - CIDR notation is allowed - Allow all IPs if left blank

Block IP

Blocked IP list
Enter the IP address and press Enter to complete the input
CIDR notation allowed
If the same IP is listed in the allowed IP list, it will be blocked instead

Request Limit

No input or 0 indicates unlimited
Unlimited cannot be modified.

Range*

Click the checkbox to set the permission scope

Click [OK] in the "Save?" popup window, then please check the issued token

Copy Token

API call

API call refers to the process of requesting a specific action from the Cocktail server.

API call

Set the Authorization header with the previously issued token

## CURL Command Sample
curl -X POST http://${API-GATEWAY}/api/pl/list/service/2 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [token]

```
curl -X POST http://${API-GATEWAY}/api/pl/list/service/2 \
```
- ${API-GATEWAY} : Enter the domain or IP:port information to access the API gateway.
```
-H 'Content-Type: application/json' \
```
```
-H 'Authorization: Bearer [token]
```
- [token] : Enter "Bearer" followed by a space, then paste the issued token.

API response

The API response is the data received from the server as a result of the requested Cocktail operation

The response may include the success of the requested task, data, error messages, etc
Below is an example of a simple JSON-formatted API response.

Response for successful task completion.

// An example of cluster list retrieval
{
    "code": "200",
    "result": [
        {
            "apiUrl": "https://0.0.0.0:0",
            "authType": "CERT",
            "clusterId": "thingcluster",
            "clusterName": "thingcluster",
            "clusterSeq": 1,
            "clusterState": "RUNNING",
            "created": "2023-12-19 09:27:00",
            "cubeType": "MANAGED",
            "description": "thingcluster",
            "ingressSupported": "Y",
            "k8sVersion": "1.26.1",
            "loadbalancerSupported": "N",
            "nodePortRange": "30000-32767",
            "nodePortSupported": "Y",
            "nodePortUrl": "0.0.0.0",
            "persistentVolumeSupported": "Y",
            "providerAccountSeq": 1,
            "regionCode": "Acornsoft",
            "updated": "2023-12-20 04:09:29",
            "useYn": "Y"
        }
    ],
    "status": "ok"
}

Item

Data type

Content

code

string

Internal Response Status Codes
Successful case: 200

result

The type varies depending on the requested task

Contents of the query

status

string

Internal response status

// Example of partial monitoring (V1)
{
    "code": "",
    "message": "",
    "metadata": null,
    "result": [
        {
            "metrics": {
                "cluster": "thingcluster",
                "controller_class": "k8s.io/ingress-nginx"
            },
            "timestamp": 1706597820,
            "value": 0.16666666666666669
        }
    ],
    "status": "ok"
}

You can determine the success of the task based on the status.

Item

Data type

Content

code

string

Value: ""

message

string

Value: ""

metadata

string

Value: null

result

The type varies depending on the requested task

Contents of the query

status

string

Internal response status
Value: "ok"

Response for failed task execution

{
    "code": "CCCM1044000",
    "message": "Not Authorized."
    "status: "error"
}

Item

Data type

Content

code

string

Internal Response Status Code

message

string

Internal Response Status Message

status

string

Internal Response Status

API REFERENCE

The API REFERENCE document below contains only the content regarding the "result" value in case of successful task execution.

API Reference

Common

Get volume types

Platform

Get platform

Get platform service maps

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

workspaces

Get workspaces list

Get workspace details

service map

Get workspace service maps list

Get workspace service map details

Get service map workloads list

Get service map workload details

Get service map groups list

pipeline

Get pipeline list

Run pipeline

Get pipeline Execution Details

Monitoring

Monitoring variables

Parameters

The parameters related to monitoring are as follows

Parameter

Description

clusterIds

Cluster ID
Enter multiple cluster IDs separated by commas(,)

namespaces

Namespace name
Enter multiple namespace names separated by commas(,)

workloadIds

Workload ID
Enter multiple workload IDs separated by commas(,)

nodeIds

Node ID
Input method (2 options)
- Enter multiple node IDs separated by commas(,)
- @each : Enter all IDs within the cluster

start

Start date for the query
timezone : UTC
format : yyyymmddhhmmss

end

End date for the query
timezone : UTC
format : yyyymmddhhmmss

Monitoring Cluster

Get cluster CPU usage trend (Core)

Get cluster Memory usage trend (Byte)

Get cluster CPU/Memory request trend (Core/Byte)

Get cluster network usage trend (Mbps)

Get cluster kube API server request

Get cluster kube API server average response time

Get cluster restart pod list

Get cluster restart pod growth rate

Get cluster pod count trend by status

Get cluster pod CPU usage Top 5 trend (Core)

Get cluster pod Memory usage Top 5 trend (Byte)

Monitoring Node

Get cluster node CPU usage trend (%)

Get cluster node CPU usage trend by status (%)

Get cluster node CPU load trend (Average Core)

Get cluster node CPU current load (Core Average)

Get cluster node Memory usage trend (Byte)

Get cluster node disk free space trend

Get cluster node disk I/O rate change trend

Get cluster node disk detailed usage rate

Get cluster node network usage (bps)

Get cluster node network usage trend by device

Get cluster node uptime

Get cluster node availability

Monitoring Ingress

Get ingress controller average connection count trend

Get ingress controller average request rate trend (ReqPS)

Get ingress controller request success rate trend

Get ingress controller CPU usage trend (Core)

API response

The API response is the data received from the server as a result of the requested Cocktail operation

The response may include the success of the requested task, data, error messages, etc
Below is an example of a simple JSON-formatted API response.

Response for successful task completion.

// An example of cluster list retrieval
{
    "code": "200",
    "result": [
        {
            "apiUrl": "https://0.0.0.0:0",
            "authType": "CERT",
            "clusterId": "thingcluster",
            "clusterName": "thingcluster",
            "clusterSeq": 1,
            "clusterState": "RUNNING",
            "created": "2023-12-19 09:27:00",
            "cubeType": "MANAGED",
            "description": "thingcluster",
            "ingressSupported": "Y",
            "k8sVersion": "1.26.1",
            "loadbalancerSupported": "N",
            "nodePortRange": "30000-32767",
            "nodePortSupported": "Y",
            "nodePortUrl": "0.0.0.0",
            "persistentVolumeSupported": "Y",
            "providerAccountSeq": 1,
            "regionCode": "Acornsoft",
            "updated": "2023-12-20 04:09:29",
            "useYn": "Y"
        }
    ],
    "status": "ok"
}

Item

Data type

Content

code

string

Internal Response Status Codes
Successful case: 200

result

The type varies depending on the requested task

Contents of the query

status

string

Internal response status

// Example of partial monitoring (V1)
{
    "code": "",
    "message": "",
    "metadata": null,
    "result": [
        {
            "metrics": {
                "cluster": "thingcluster",
                "controller_class": "k8s.io/ingress-nginx"
            },
            "timestamp": 1706597820,
            "value": 0.16666666666666669
        }
    ],
    "status": "ok"
}

You can determine the success of the task based on the status.

Item

Data type

Content

code

string

Value: ""

message

string

Value: ""

metadata

string

Value: null

result

The type varies depending on the requested task

Contents of the query

status

string

Internal response status
Value: "ok"

Response for failed task execution

{
    "code": "CCCM1044000",
    "message": "Not Authorized."
    "status: "error"
}

Item

Data type

Content

code

string

Internal Response Status Code

message

string

Internal Response Status Message

status

string

Internal Response Status

API REFERENCE

The API REFERENCE document below contains only the content regarding the "result" value in case of successful task execution.

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

clusterIdstringrequired

namespaceNamestringrequired

cronJobNamestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/clusters/{clusterId}/namespaces/{namespaceName}/cronjobs/{cronJobName}'

200

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

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

clusterIdstringrequired

namespaceNamestringrequired

deploymentNamestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/clusters/{clusterId}/namespaces/{namespaceName}/deployments/{deploymentName}'

200

[
  {
    "creationTimestamp": "2023-05-02 07:12:02",
    "deployment": "{\"apiVersion\":\"apps/v1\",\"kind\":\"Deployment\"...",
    "deploymentYaml": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n...",
    "desiredPodCnt": 1,
    "detail": {
      "creationTime": "2023-05-02 01:45:53",
      "minReadySeconds": 0,
      "name": "cocktail-log-api",
      "namespace": "cocktail-system",
      "replicas": 1,
      "revisionHistoryLimit": "10",
      "strategy": "RollingUpdate",
      "annotations": {
        "acornsoft.io/workload-group-no": "12",
        "cocktail-deploy-datetime": "2023-06-28 08:10:52.898",
        "cocktail-user-description": ""
      },
      "labels": {
        "app": "api",
        "app.kubernetes.io/managed-by": "Helm",
        "chart": "api-1.0.0"
      },
      "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
      },
      "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": {
          "podStatus": "Pending",
          "restartCnt": 0,
          "conditions": [],
          "detail": {
            "restartPolicy": "Always",
            "terminationGracePeriodSeconds": 30,
            "initContainers": [],
            "imagePullSecrets": [
              {
                "name": "devops-cocktail-t4f1hevxvkmv"
              }
            ],
            "containers": [
              {
                "image": "regi.acloud.run/library/log-api:1.3.0",
                "imagePullPolicy": "Always",
                "name": "api",
                "restartCount": 0,
                "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"
                },
                "volumeMounts": {
                  "app-volume": "{\"mountPath\":\"/var/log/app\",\"name\":\"app-volume\",\"subPath\":\"cocktail-log-api\"}",
                  "loki-cert": "{\"mountPath\":\"/etc/loki/cert\",\"name\":\"loki-cert\"}"
                },
                "resources": {
                  "cpu": {
                    "limit": "5",
                    "request": "100m"
                  },
                  "memory": {
                    "limit": "5242880k",
                    "request": "134217728"
                  }
                }
              }
            ]
          }
        }
      }
    },
    "name": "cocktail-log-api",
    "namespace": "cocktail-system",
    "readyPodCnt": 1,
    "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"
      }
    ],
    "images": [
      "regi.acloud.run/library/log-api:1.3.0"
    ],
    "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,
        "name": "cocktail-log-api-9d5bcff4",
        "namespace": "cocktail-system",
        "readyPodCnt": 1,
        "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"
        },
        "detail": {
          "creationTime": "2023-06-28 08:10:52",
          "name": "cocktail-log-api-9d5bcff4",
          "namespace": "cocktail-system",
          "images": [
            "regi.acloud.run/library/log-api:1.3.0"
          ],
          "podsStatus": {},
          "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"
          },
          "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"
          },
          "pods": {
            "running": 1
          },
          "ownerReferences": [
            {
              "apiVersion": "apps/v1",
              "blockOwnerDeletion": true,
              "controller": true,
              "kind": "Deployment",
              "name": "cocktail-log-api",
              "uid": "85f52a56-52e7-4289-8777-25f8c78d60e5"
            }
          ],
          "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"
            }
          },
          "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": {
              "podStatus": "Pending",
              "restartCnt": 0,
              "conditions": [],
              "detail": {
                "restartPolicy": "Always",
                "terminationGracePeriodSeconds": 30,
                "initContainers": [],
                "imagePullSecrets": [
                  {
                    "name": "devops-cocktail-t4f1hevxvkmv"
                  }
                ],
                "containers": [
                  {
                    "image": "regi.acloud.run/library/log-api:1.3.0",
                    "imagePullPolicy": "Always",
                    "name": "api",
                    "restartCount": 0,
                    "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"
                    },
                    "volumeMounts": {
                      "app-volume": "{\"mountPath\":\"/var/log/app\",\"name\":\"app-volume\",\"subPath\":\"cocktail-log-api\"}",
                      "loki-cert": "{\"mountPath\":\"/etc/loki/cert\",\"name\":\"loki-cert\"}"
                    },
                    "resources": {
                      "cpu": {
                        "limit": "5",
                        "request": "100m"
                      },
                      "memory": {
                        "limit": "5242880k",
                        "request": "134217728"
                      }
                    }
                  }
                ]
              }
            }
          }
        }
      }
    ],
    "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"
    }
  }
]

Get service map workload details

Get detailed information for the workloads in the specified workspace and service map.

get

/v1/workspaces/{workspaceSeq}/servicemaps/{servicemapSeq}/workloads/{workloadName}

Path parameters

workspaceSeqintegerrequired

servicemapSeqintegerrequired

workloadNamestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/workspaces/{workspaceSeq}/servicemaps/{servicemapSeq}/workloads/{workloadName}'

200

{
  "namespaceName": "cocktail-system",
  "workloadGroups": [
    {
      "columnCount": 1,
      "servicemapSeq": 2,
      "sortOrder": 1,
      "useYn": "Y",
      "workloadGroupName": "Default",
      "workloadGroupSeq": 2
    }
  ],
  "workloads": [
    {
      "activeCount": 1,
      "computeTotal": 1,
      "creationTimestamp": "2023-04-29 05:54:54",
      "description": "",
      "namespaceName": "cocktail-system",
      "qos": "BestEffort",
      "stateCode": "RUNNING",
      "workloadGroupSeq": 11,
      "workloadName": "cocktail-api-cmdb",
      "workloadType": "STATEFUL_SET_SERVER",
      "containers": [
        {
          "containerName": "api-cmdb",
          "fullImageName": "0.0.0.0/library/api-cmdb:4.7.4-release.20230413",
          "initContainerYn": "N",
          "privateRegistryYn": "N"
        }
      ],
      "serverUrls": [
        {
          "serviceType": "CLUSTER_IP",
          "url": "10.187.158.194:3306"
        }
      ],
      "services": [
        {
          "clusterIp": "0.0.0.0",
          "headlessFlag": false,
          "internalLBFlag": false,
          "name": "api-cmdb",
          "namespaceName": "cocktail-system",
          "serviceType": "CLUSTER_IP",
          "stickySessionFlag": false,
          "ports": [
            {
              "port": 0,
              "protocol": "TCP",
              "targetPort": "0"
            }
          ]
        }
      ],
      "pods": [
        {
          "namespace": "cocktail-system",
          "nodeName": "apps-gpu-v100",
          "podName": "cocktail-api-cmdb-0",
          "podStatus": "Running",
          "restartCnt": 0,
          "startTime": "2023-05-01 09:20:09",
          "conditions": [
            {
              "lastTransitionTime": "2023-05-01 09:20:19",
              "status": "True",
              "type": "Initialized"
            }
          ],
          "detail": {
            "creationTime": "2023-05-01 09:20:09",
            "hostname": "cocktail-api-cmdb-0",
            "namespace": "cocktail-system",
            "nodeName": "apps-gpu-v100",
            "podIP": "10.177.142.134",
            "podName": "cocktail-api-cmdb-0",
            "podStatus": "Running",
            "qosClass": "Burstable",
            "restartPolicy": "Always",
            "serviceAccountName": "default",
            "startTime": "2023-05-01 09:20:09",
            "terminationGracePeriodSeconds": 60,
            "annotations": {
              "cni.projectcalico.org/containerID": "2869a9d6ccd7a53fc8fdccda05168581a99115ffacd7beb834d816e2ab2ee6e7",
              "cni.projectcalico.org/podIP": "10.177.142.134/32",
              "cni.projectcalico.org/podIPs": "10.177.142.134/32"
            },
            "labels": {
              "app": "api-cmdb",
              "app.kubernetes.io/instance": "cocktail",
              "app.kubernetes.io/managed-by": "Helm"
            },
            "ownerReferences": [
              {
                "apiVersion": "apps/v1",
                "blockOwnerDeletion": true,
                "controller": true,
                "kind": "StatefulSet",
                "name": "cocktail-api-cmdb",
                "uid": "cd832df7-397a-4f17-9e38-0fc0f3f5baa0"
              }
            ],
            "tolerations": [
              {
                "effect": "NoExecute",
                "key": "node.kubernetes.io/not-ready",
                "operator": "Exists",
                "tolerationSeconds": 30
              },
              {
                "effect": "NoExecute",
                "key": "node.kubernetes.io/unreachable",
                "operator": "Exists",
                "tolerationSeconds": 30
              }
            ],
            "containers": [
              {
                "containerID": "containerd://6b87d5769493be45af8a48e97f5bab7ae7cfe8cc4e39d7d2b15ebda3a79da2eb",
                "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,
                "restartCount": 0,
                "startTime": "2023-05-01 09:20:19",
                "state": "{\"running\":{\"startedAt\":\"2023-05-01T09:20:19.000000Z\"}}",
                "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"
                ],
                "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\"}"
                },
                "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\"}"
                },
                "resources": {
                  "cpu": {
                    "limit": "1",
                    "request": "500m"
                  },
                  "memory": {
                    "limit": "2Gi",
                    "request": "1Gi"
                  }
                }
              }
            ],
            "initContainers": [
              {
                "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,
                "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\"}}",
                "commands": [
                  "/usr/sbin/init_api_cmdb.sh"
                ],
                "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\"}"
                },
                "resources": {
                  "cpu": {
                    "limit": "20m",
                    "request": "20m"
                  },
                  "memory": {
                    "limit": "50Mi",
                    "request": "50Mi"
                  }
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

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

clusterIdstringrequired

namespaceNamestringrequired

pvcNamestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/clusters/{clusterId}/namespaces/{namespaceName}/persistentvolumeclaims/{pvcName}'

200

{
  "clusterVolume": {
    "baseStorageYn": "Y",
    "description": "",
    "name": "nfs-csi",
    "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",
    "mountOptions": [
      "hard",
      "nfsvers=4.1"
    ],
    "annotations": {
      "cocktail-user-description": "bmZzLWNzaQ==",
      "meta.helm.sh/release-name": "default-storage",
      "meta.helm.sh/release-namespace": "kube-system"
    },
    "labels": {
      "acornsoft.io/provisioner-type": "NFS_CSI",
      "acornsoft.io/total-capacity": "1024",
      "acornsoft.io/type": "NETWORK"
    },
    "parameters": [
      {
        "name": "server",
        "value": "0.0.0.0"
      }
    ]
  },
  "creationTimestamp": "2023-04-29 05:54:51",
  "deployment": "{\"apiVersion\":\"v1\",\"kind\":\"PersistentVolumeClaim\"...",
  "deploymentYaml": "apiVersion: v1\nkind: PersistentVolumeClaim\nmetadata:...",
  "detail": {
    "creationTimestamp": "2023-04-29 05:54:51",
    "name": "cocktail-api-cmdb-logdata",
    "namespace": "cocktail-system",
    "status": "Bound",
    "storageClassName": "nfs-csi",
    "volumeName": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482",
    "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"
    },
    "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",
  "persistentVolume": {
    "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...",
    "name": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482",
    "persistentVolumeReclaimPolicy": "Retain",
    "status": "Bound",
    "storageClassName": "nfs-csi",
    "accessModes": [
      "ReadWriteMany"
    ],
    "capacity": {
      "storage": "20Gi"
    },
    "detail": {
      "claimName": "cocktail-system/cocktail-api-cmdb-logdata",
      "creationTime": "2023-04-29 05:54:51",
      "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\":...",
      "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"
      },
      "labels": {
        "app.kubernetes.io/instance": "cocktail",
        "app.kubernetes.io/managed-by": "Helm",
        "app.kubernetes.io/name": "api-cmdb"
      },
      "events": [
        {
          "message": "",
          "source": "",
          "subObject": "",
          "count": 0,
          "firstTime": "2023-04-29 05:54:51",
          "lastTime": "2023-04-29 05:54:51",
          "kind": "",
          "name": "",
          "namespace": "",
          "deployment": "",
          "deploymentYaml": "",
          "involvedObject": {
            "apiVersion": "",
            "fieldPath": "",
            "kind": "",
            "name": "",
            "namespace": "",
            "resourceVersion": "",
            "uid": ""
          },
          "related": {
            "apiVersion": "",
            "fieldPath": "",
            "kind": "",
            "name": "",
            "namespace": "",
            "resourceVersion": "",
            "uid": ""
          }
        }
      ]
    }
  },
  "persistentVolumeType": "SHARED",
  "status": "Bound",
  "storageClassName": "nfs-csi",
  "volumeName": "pvc-1eaa501f-b51a-42a0-8304-9e3b5c151482",
  "accessModes": [
    "ReadWriteMany"
  ],
  "serverParams": [
    {
      "namespaceName": "cocktail-system",
      "serverName": "cocktail-api-cmdb",
      "containerVolumes": [
        {
          "containerName": "api-cmdb",
          "containerPath": "/var/log/mysql",
          "subPath": "api-cmdb",
          "useMemoryYn": "N",
          "volumeName": "log"
        }
      ]
    }
  ],
  "capacity": {
    "storage": "20Gi"
  }
}

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

clusterIdstringrequired

namespaceNamestringrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/clusters/{clusterId}/namespaces/{namespaceName}/pods'

200

[
  {
    "detail": {
      "creationTimestamp": "2023-05-01 09:20:09",
      "hostname": "cocktail-api-cmdb-0",
      "namespace": "cocktail-system",
      "nodeName": "apps-gpu-v100",
      "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,
      "annotations": {
        "cni.projectcalico.org/containerID": "2869a9d6ccd7a53fc8fdccda05168581a99115ffacd7beb834d816e2ab2ee6e7",
        "cni.projectcalico.org/podIP": "0.0.0.0/0",
        "cni.projectcalico.org/podIPs": "0.0.0.0/0"
      },
      "labels": {
        "app": "api-cmdb",
        "app.kubernetes.io/instance": "cocktail",
        "app.kubernetes.io/managed-by": "Helm"
      },
      "ownerReferences": [
        {
          "apiVersion": "apps/v1",
          "blockOwnerDeletion": true,
          "controller": true,
          "kind": "StatefulSet",
          "name": "cocktail-api-cmdb",
          "uid": "cd832df7-397a-4f17-9e38-0fc0f3f5baa0"
        }
      ],
      "tolerations": [
        {
          "effect": "NoExecute",
          "key": "node.kubernetes.io/not-ready",
          "operator": "Exists",
          "tolerationSeconds": 30
        }
      ],
      "initContainers": [
        {
          "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,
          "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\"}}",
          "commands": [
            "/usr/sbin/init_api_cmdb.sh"
          ],
          "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\"}"
          },
          "resources": {
            "cpu": {
              "limit": "20m",
              "request": "20m"
            },
            "memory": {
              "limit": "50Mi",
              "request": "50Mi"
            }
          }
        }
      ],
      "containers": [
        {
          "containerID": "containerd://6b87d5769493be45af8a48e97f5bab7ae7cfe8cc4e39d7d2b15ebda3a79da2eb",
          "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,
          "restartCount": 0,
          "startTime": "2023-05-01 09:20:19",
          "state": "{\"running\":{\"startedAt\":\"2023-05-01T09:20:19.000000Z\"}}",
          "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"
          ],
          "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\"}"
          },
          "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\"}"
          },
          "resources": {
            "cpu": {
              "limit": "1",
              "request": "500m"
            },
            "memory": {
              "limit": "2Gi",
              "request": "1Gi"
            }
          }
        }
      ]
    },
    "namespace": "cocktail-system",
    "nodeName": "apps-gpu-v100",
    "podName": "cocktail-api-cmdb-0",
    "podStatus": "Running",
    "restartCnt": 0,
    "startTime": "2023-05-01 09:20:09",
    "conditions": [
      {
        "lastTransitionTime": "22023-05-01 09:20:19",
        "status": "True",
        "type": "Initialized"
      }
    ]
  }
]

OpenAPI - R4.8.1 - EN

What is Cocktail Open API?

Introduction

Getting Started

The operation of API authentication tokens

API INFORMATION

API Token Issuance

Issue Token

Copy Token

API call

API call

API response

Response for successful task completion.

Response for failed task execution

API REFERENCE

API Reference

Common

Get volume types

Platform

Get platform

Get platform service maps

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

workspaces

Get workspaces list

Get workspace details

service map

Get workspace service maps list

Get workspace service map details

Get service map workloads list

Get service map workload details

Get service map groups list

pipeline

Get pipeline list

Run pipeline

Get pipeline Execution Details

Monitoring

Monitoring variables

What is Cocktail Open API?

What is Cocktail Open API?