Help Center> > API Reference> Before You Start

Before You Start

Updated at: May 30, 2019 17:25

This document describes functions, syntax, parameters, and examples of the application programming interfaces (APIs) of cloud container engine (CCE). Table 1 provides links to these contents.

Table 1 Introduction

Chapter

Description

API Overview

Understand the CCE API components and API lists.

Setting Up the Environment

Prepare for using APIs, for example, creating a VPC and obtaining request authentication information.

Using APIs

Understand REST message body, invoking method, and examples.

API

Understand how to use APIs, such as the APIs for managing clusters, storage, and secrets.

Common Parameters

Understand the common parameters, status codes, and error codes.

APIs provided by CCE are classified into two types: proprietary APIs and Kubernetes-native APIs. With these APIs, you are enabled to use all functions of CCE. For more information about Kubernetes concepts, visit https://kubernetes.io/docs/concepts/. For details about Kubernetes-native API versions, see 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.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel