Updated on 2023-07-03 GMT+08:00

Overview

Cloud Container Engine (CCE) is a container service that allows you to run containers efficiently in the cloud. CCE provides highly scalable, high-performance, enterprise-class Kubernetes clusters and supports Docker containers. With CCE, you can easily deploy, manage, and scale containerized applications in the cloud.

This document describes how to use APIs to perform operations on CCE, such as creating or deleting CCE resources, modifying resource specifications, or adding NICs. For details about all supported operations, see API Overview.

If you plan to access CCE resources through an API, ensure that you are familiar with CCE concepts.

In addition, CCE supports both native Kubernetes APIs and CCE APIs. With these APIs, you can use all functions of CCE.

For details about Kubernetes-native API versions, visit https://kubernetes.io/docs/concepts/overview/kubernetes-api/.

In addition:

  • The Kubernetes-native APIs called in the current version do not support HTTP persistent connections.
  • The Kubernetes-native APIs in the current version include Beta APIs, whose version names include beta, for example, v1beta1. This type of APIs varies according to Kubernetes-native APIs. Therefore, you are advised to use this type of APIs in unimportant scenarios, for example, short-term test clusters.

Use the methods described in this document to call APIs. If other methods, such as kubectl and SDKs, are used to call APIs, the APIs may fail to work.

This document describes functions, syntax, parameters, and examples of CCE APIs. You can find the information you need according to Table 1.

Table 1 Document organization

Section

Description

API overview

General introduction to CCE APIs

Environment preparation

Preparations before using APIs, for example, creating a VPC and obtaining request authentication information

Using APIs

REST API messages, calling methods, and examples

API

CCE APIs to serve specific purposes, such as cluster management, storage management, and secret management

Common parameters

Common parameters, status codes, and error codes of CCE APIs