API Reference

• Overview

• APIs

  • API Calling

  • Uploading an AK/SK File

  • Creating a VPC

  • Creating a Key Pair

  • Authenticating Requests

    • Token Authentication

    • AK/SK Authentication

  • Obtaining Cluster UUID

  • Constructing Requests

  • Initiating Requests

  • Parsing Responses

  • Status Codes

• Common Parameters

  • Common Request Parameters

  • Common Response Parameters

• Cluster and Host Management (Proprietary APIs)

  • Constructing Requests

  • Creating a Container Cluster

  • Adding a Node to a Container Cluster

  • Updating Container Cluster Information

  • Deleting Nodes from a Container Cluster

  • Deleting a Container Cluster

  • Obtaining Information About All Clusters

  • Obtaining Information About a Specified Cluster

  • Obtaining Information About All Hosts in a Specified Cluster

  • Obtaining Information About a Specified Host in a Specified Cluster

  • Obtaining Certificates for Accessing a Container Cluster

• Metrics and Logs (Proprietary APIs)

  • Constructing Requests

  • Obtaining Cluster Monitoring Metrics

  • Obtaining Monitoring Metrics of All Nodes in a Cluster

  • Obtaining Monitoring Metrics of a Specified Cluster Node

  • Obtaining Monitoring Metrics of All Application Instances in a Specified Namespace in a Cluster

  • Obtaining Monitoring Metrics of a Specified Application Instance in a Specified Namespace in a Cluster

  • Application Logs

• Secret (Native Kubernetes APIs)

  • Constructing Requests

  • Creating a Secret

  • Deleting a Secret

  • Reading a Specified Secret

  • Replacing a Specified Secret

  • Listing or Watching objects of kind Secret in a Specified Namespace

  • Listing or Watching objects of kind Secret

• ReplicationController (Native Kubernetes APIs)

  • Constructing Requests

  • Creating a ReplicationController

  • Deleting a ReplicationController

  • Reading a Specified ReplicationController

  • Replacing a Specified ReplicationController

  • Replacing the Status of a Specified ReplicationController

  • Listing or Watching Objects of ReplicationController in a Specified Namespace

  • Listing or Watching Objects of ReplicationController

  • Partially Updating a Specified ReplicationController

• Service (Native Kubernetes APIs)

  • Constructing Requests

  • Creating a Service

  • Deleting a Service

  • Reading a Specified Service

  • Replacing a Specified Service

  • Listing or Watching Objects of Kind Service in a Specified Namespace

  • Listing or Watching Objects of Kind Service

  • Partially Updating a Specified Service

  • Proxying GET Requests to a Service with Path

  • Proxying GET Requests to a Service

  • Proxying DELETE Requests to a Service with Path

  • Proxying DELETE Requests to a Service

  • Proxying PUT Requests to a Service with Path

  • Proxying PUT Requests to a Service

  • Proxying POST Requests to a Service with Path

  • Proxying POST Requests to a Service

  • Proxying HEAD Requests to a Service with Path

  • Proxying HEAD Requests to a Service

  • Proxying OPTIONS Requests to a Service with Path

  • Proxying OPTIONS Requests to a Service

  • Replacing the Status of a Specified Service

• Pod (Native Kubernetes APIs)

  • Constructing Requests

  • Creating a Pod

  • Deleting a Pod

  • Reading a Specified Pod

  • Reading Logs of a Specified Pod

  • Replacing a Specified Pod

  • Replacing the Status of a Specified Pod

  • Listing or Watching Objects of Kind Pod in a Specified Namespace

  • Listing or Watching Objects of Kind Pod

  • Partially Updating a Specified Pod

  • Proxying GET Requests to a Pod with Path

  • Proxying GET Requests to a Pod

  • Proxying DELETE Requests to a Pod with Path

  • Proxying DELETE Requests to a Pod

  • Proxying PUT Requests to a Pod with Path

  • Proxying PUT Requests to a Pod

  • Proxying POST Requests to a Pod with Path

  • Proxying POST Requests to a Pod

  • Proxying HEAD Requests to a Pod with Path

  • Proxying HEAD Requests to a Pod

  • Proxying OPTIONS Requests to a Pod with Path

  • Proxying OPTIONS Requests to a Pod

  • Connecting GET Requests to the Proxy of a Pod

  • Connecting GET Requests to the Proxy of a Pod with Path

  • Connecting DELETE Requests to the Proxy of a Pod

  • Connecting DELETE Requests to the Proxy of a Pod with Path

  • Connecting PUT Requests to the Proxy of a Pod

  • Connecting PUT Requests to the Proxy of a Pod with Path

  • Connecting POST Requests to the Proxy of a Pod

  • Connecting POST Requests to the Proxy of a Pod with Path

  • Connecting HEAD Requests to the Proxy of a Pod

  • Connecting HEAD Requests to the Proxy of a Pod with Path

  • Connecting OPTIONS Requests to the Proxy of a Pod

  • Connecting OPTIONS Requests to the Proxy of a Pod with Path

• PodTemplate (Native Kubernetes APIs)

  • Constructing Requests

  • Creating a PodTemplate

  • Deleting a PodTemplate

  • Reading a Specified PodTemplate

  • Replacing a Specified PodTemplate

  • Listing or Watching Objects of Kind PodTemplate in a Specified Namespace

  • Listing or Watching Objects of kind PodTemplate

  • Partially Updating a Specified PodTemplate

• Namespace (Native Kubernetes APIs)

  • Constructing Requests

  • Creating a Namespace

  • Deleting a Namespace

  • Reading a Specified Namespace

  • Replacing a Specified Namespace

  • Replacing the Status of a Specified Namespace

  • Replacing the Finalize Value of a Specified Namespace

  • Listing or Watching Objects of Kind Namespace

  • Partially Updating a Specified Namespace

• Endpoints (Native Kubernetes APIs)

  • Constructing Requests

  • Creating an Endpoints

  • Deleting an Endpoints

  • Reading a Specified Endpoints

  • Replacing a Specified Endpoints

  • Listing or Watching Objects of Kind Endpoints

  • Listing or Watching Objects of Kind Endpoints in a Specified Namespace

  • Partially Updating a Specified Endpoints

• StatefulSet (Native Kubernetes APIs)

  • Constructing Requests

  • Creating a StatefulSet

  • Deleting a StatefulSet

  • Reading a Specified StatefulSet

  • Reading the Status of a Specified StatefulSet

  • Replacing a Specified StatefulSet

  • Replacing the Status of a Specified StatefulSet

  • Listing or Watching Objects of Kind StatefulSet in a Specified Namespace

  • Listing or Watching Objects of Kind StatefulSet

  • Partially Updating a Specified StatefulSet

  • Partially Updating the Status of a Specified StatefulSet

• PersistentVolumeClaim (Native Kubernetes APIs)

  • Constructing Requests

  • Creating a PersistentVolumeClaim

  • Deleting a PersistentVolumeClaim

  • Reading a Specified PersistentVolumeClaim

  • Replacing a Specified PersistentVolumeClaim

  • Replacing the Status of a Specified PersistentVolumeClaim

  • Listing or Watching Objects of Kind PersistentVolumeClaim in a Specified Namespace

  • Listing or Watching Objects of Kind PersistentVolumeClaim

  • Partially Updating a Specified PersistentVolumeClaim

• PersistentVolume (Native Kubernetes APIs)

  • Constructing Requests

  • Creating a PersistentVolume

  • Deleting a PersistentVolume

  • Reading a Specified PersistentVolume

  • Replacing a Specified PersistentVolume

  • Replacing the Status of a Specified PersistentVolume

  • Listing or Watching Objects of Kind PersistentVolume

  • Partially Updating a Specified PersistentVolume

• Appendix

  • Patch Request Method Operation Description

  • Patch Request Method Operation Example

  • Using ELB with a Cluster

  • Using kubectl to Access a Container Cluster

  • Using an External Private Container Image

  • Using kubectl to Interconnecting PV with EVS

• Change History

API Reference 2.0

• API Usage Guidelines

• Setting Up the Environment

  • Creating a VPC

  • Creating a Key Pair

  • (Optional) Creating a High-Speed Network

• API

  • API Version Query

    • Querying All API Versions

    • Querying Information About API v3

  • Cluster Management

    • Creating a Container Cluster

    • Obtaining Information About a Specified Cluster

    • Obtaining Information About Clusters in a Specific Project

    • Updating Information About a Specified Cluster

    • Deleting a Specified Container Cluster

    • Obtaining Cluster Certificates

    • Creating a Node

    • Obtaining Information About a Node in a Specified Cluster

    • Obtaining the List of Nodes of a Specified Cluster

    • Updating Information about a Specified Node

    • Deleting a Node from a Specified Cluster

    • Obtaining the Progress of a Specified Job

    • Querying the Access Information of a Specified Cluster

    • Modifying the Access Information of a Specified Cluster

  • Storage Management

    • Creating a Persistent Volume Claim

    • Deleting a Persistent Volume Claim

    • Creating a Persistent Volume

    • Deleting a Persistent Volume

• Kubernetes API

  • Secret

    • Creating a Secret

    • Deleting a Secret

    • Deleting All Secrets

    • Reading a Specified Secret

    • Replacing a Specified Secret

    • Listing All Secrets Under a Specified Namespace

    • Listing All Secrets in a Cluster

  • ReplicationController

    • Creating a ReplicationController

    • Deleting a ReplicationController

    • Deleting All ReplicationControllers

    • Reading a ReplicationController Under a Specified Namespace

    • Replacing a ReplicationController Under a Specified Namespace

    • Replacing the Status of a ReplicationController Under a Specified Namespace

    • Listing ReplicationControllers Under a Specified Namespace

    • Listing ReplicationControllers

    • Updating a Specified ReplicationController

  • Service

    • Creating a Service

    • Deleting a Service

    • Reading a Specified Service

    • Replacing a Specified Service

    • Listing a Services Under a Specified Namespace

    • Listing Services

    • Updating a Specified Service

    • Replacing the Status of a Specified Service

  • Pod

    • Creating a Pod

    • Deleting a Pod

    • Deleting All Pods

    • Reading a Specified Pod

    • Replacing a Specified Pod

    • Replacing the Status of a Specified Pod

    • Listing All Pods Under a Specified Namespace

    • Listing Pods

    • Updating a Specified Pod

  • Namespace

    • Creating a Namespace

    • Deleting a Namespace

    • Reading a Specified Namespace

    • Replacing a Specified Namespace

    • Replacing the Status of a Specified Namespace

    • Replacing the Finalize Value of a Specified Namespace

    • Listing Namespaces

    • Updating a Specified Namespace

  • Endpoints

    • Creating an Endpoint

    • Deleting an Endpoint

    • Deleting All Endpoints

    • Reading a Specified Endpoints

    • Replacing a Specified Endpoints

    • Listing Endpoints

    • Listing Endpoints Under a Specified Namespace

    • Updating a Specified Endpoints

  • PersistentVolumeClaim

    • Creating a PersistentVolumeClaim

    • Deleting a PersistentVolumeClaim

    • Deleting All PersistentVolumeClaims

    • Reading a Specified PersistentVolumeClaim

    • Replacing a Specified PersistentVolumeClaim

    • Replacing the Status of a Specified PersistentVolumeClaim

    • Listing PersistentVolumeClaims Under a Specified Namespace

    • Listing PersistentVolumeClaims

    • Updating a Specified PersistentVolumeClaim

  • PersistentVolume

    • Creating a PersistentVolume

    • Deleting a PersistentVolume

    • Deleting All PersistentVolumes

    • Reading a Specified PersistentVolume

    • Replacing a Specified PersistentVolume

    • Replacing the Status of a Specified PersistentVolume

    • Listing PersistentVolumes

    • Updating a Specified PersistentVolume

  • Deployment

    • Creating a Deployment

    • Creating Rollback of a Deployment

    • Deleting a Deployment

    • Deleting All Deployments

    • Reading a Specified Deployment

    • Reading the Status of a Specified Deployment

    • Reading the Scale of a Specified Deployment

    • Replacing a Specified Deployment

    • Replacing the Status of a Specified Deployment

    • Replacing the Scale of a Specified Deployment

    • Listing Deployments Under a Specified Namespace

    • Listing Deployments

    • Updating a Specified Deployment

    • Updating the Status of a Specified Deployment

    • Updating the Scale of a Specified Deployment

  • DaemonSet

    • Creating a DaemonSet

    • Deleting a DaemonSet

    • Deleting All DaemonSets

    • Reading a Specified DaemonSet

    • Reading the Status of a Specified DaemonSet

    • Replacing a Specified DaemonSet

    • Replacing the Status of a Specified DaemonSet

    • Listing DaemonSets in a Specified Namespace

    • Listing DaemonSets

    • Updating a Specified DaemonSet

    • Updating the Status of a Specified DaemonSet

  • StatefulSet

    • Creating a StatefulSet

    • Deleting a StatefulSet

    • Deleting All StatefulSets

    • Reading a Specified StatefulSet

    • Reading the Status of a Specified StatefulSet

    • Replacing a Specified StatefulSet

    • Replacing the Status of a Specified StatefulSet

    • Listing StatefulSets Under a Specified Namespace

    • Listing StatefulSets

    • Updating a Specified StatefulSet

    • Updating the Status of a Specified StatefulSet

  • Job

    • Creating a Job

    • Deleting a Job

    • Deleting All Jobs

    • Reading a Specified Job

    • Reading the Status of a specified Job

    • Replacing a Specified Job

    • Replacing the Status of a Specified Job

    • Listing Jobs Under a Specified Namespace

    • Listing Jobs

    • Updating the Status of a Specified Job

    • Updating a Specified Job

  • CronJob

    • Creating a CronJob

    • Deleting a CronJob

    • Deleting All CronJobs

    • Reading a Specified CronJob

    • Reading the Status of a Specified CronJob

    • Replacing a Specified CronJob

    • Replacing the Status of a Specified CronJob

    • Listing CronJobs Under a Specified Namespace

    • Listing CronJobs

    • Updating the Status of a Specified CronJob

    • Updating a Specified CronJob

  • ConfigMap

    • Creating a ConfigMap

    • Deleting a ConfigMap

    • Deleting All ConfigMaps

    • Reading a Specified ConfigMap

    • Replacing a Specified ConfigMap

    • Listing ConfigMaps Under a Specified Namespace

    • Listing ConfigMaps

    • Updating a Specified ConfigMap

  • Node

    • Reading a Specified Node

    • Listing Nodes

    • Updating a Specified Node

  • ReplicSet

    • Listing ReplicaSet

  • Event

    • Listing Events

  • APIGroups

    • Listing APIVersions

    • Listing APIGroups

    • Listing APIResources of GroupVersion apiregistration.k8s.io/v1beta1

    • Listing APIResources of GroupVersion extensions/v1beta1

    • Listing APIResources of GroupVersion apps/v1beta1

    • Listing APIResources of GroupVersion authentication.k8s.io/v1

    • Listing APIResources of GroupVersion authentication.k8s.io/v1beta1

    • Listing APIResources of GroupVersion authorization.k8s.io/v1

    • Listing APIResources of GroupVersion authorization.k8s.io/v1beta1

    • Listing APIResources of GroupVersion autoscaling/v1

    • Listing APIResources of GroupVersion batch/v1

    • Listing APIResources of GroupVersion certificates.k8s.io/v1beta1

    • Listing APIResources of GroupVersion networking.k8s.io/v1

    • Listing APIResources of GroupVersion policy/v1beta1

    • Listing APIResources of GroupVersion rbac.authorization.k8s.io/v1beta1

    • Listing APIResources of GroupVersion storage.k8s.io/v1

    • Listing APIResources of GroupVersion storage.k8s.io/v1beta1

    • Listing APIResources of GroupVersion apiextensions.k8s.io/v1beta1

    • Listing APIResources of GroupVersion v1

• Common Parameters

  • Common Request Parameters

  • Common Response Parameters

  • Status Codes

  • Error Codes

• Appendix

  • Patch Request Method Operation Description

  • Patch Request Method Operation Example

  • Using ELB with a Cluster

• Change History

User Guide

• Overview

  • Basic Concepts

  • Accessing CCE

  • Related Services

  • User Permissions

  • Related Concepts

• Set-Up

  • Selecting Region and Project

  • Uploading an AK/SK File

  • Creating a VPC

  • Creating a Key Pair

  • (Optional) Creating a Load Balancer

• Getting Started

  • Overview

  • Creating a Container Cluster

  • Building Container Images

  • Uploading Container Images

  • Creating Component Templates

  • Creating a Containerized Application

• Operation Guide

  • Dashboard

  • Cluster Manager

    • Creating a Container Cluster

    • Managing a Container Cluster

    • Deleting a Container Cluster

    • Upgrading a Container Cluster

    • Accessing a Container Cluster

  • Component Template

  • App Manager

    • Creating a Containerized Application

    • Updating a Containerized Application

    • Managing a Containerized Application

    • Viewing an Application Topology

    • Deleting a Containerized Application

  • App Designer

    • Creating a Graphical App Design

    • Deploying a Containerized Application

    • Viewing an Application Template

    • Modifying an Application Template

    • Deleting an Application Template

  • Container Registry

    • Building a Container Image

    • Connecting to the Private Container Registry

    • (Optional) Signing Container Images

    • Uploading a Private Container Image Through Extranet

    • Uploading a Private Container Image Through Intranet

    • Viewing a Private Container Image

    • Modifying a Private Container Image

    • Deleting a Private Container Image

    • Deleting Residual Private Image Files

    • Querying a Private Container Image Using an API

    • Deleting a Private Container Image Using an API

    • Querying Tags of a Private Container Image Using an API

    • Deleting Tags of a Private Container Image Using an API

• FAQs

  • What Is CCE?

  • What Is a Container Cluster?

  • What Is the Relationship Between Containerized Application Component and Container?

  • What Is the App Designer?

  • What Is a Service?

  • What Is a Namespace?

  • What Is a Container Image?

  • What Is a Node?

  • What Is a Component Template?

  • What Is an Environmental Variable?

  • What Is a Volume?

  • What Is a mcore?

  • What Are the Common Use Scenarios of CCE Services?

  • Which Browsers Are Compatible with CCE Console?

  • How to Attach a Data Disk?

  • How CCE Services Are Priced?

  • Is It Possible to Recover Related Data After a Container Cluster Is Deleted?

  • What Are the Possible Causes of a Containerized Application Deployment Failure?

  • Why Does Node Status Mismatch Application Status?

  • Why Is the Latest Image Version Not Automatically Selected After Image Update?

  • How to Use External Private Container Images By Means of kubectl?

  • How to Access an External Docker Hub from a Node Without an EIP?

  • How to Set the Log Policy for a Kubernetes Component?

• Glossary

• Change History

User Guide 2.0

• Overview

  • Basic Concepts

  • Accessing CCE

  • Related Services

  • User Permissions

  • Related Concepts

• Getting Started

  • Creating a VPC and a Key Pair

  • Creating a Container Cluster

  • Creating a Containerized Application

  • Configuring Auto Scaling Policies

  • Monitoring an Application

  • Deleting Resources

• Cluster Management

  • Cluster Overview

  • Creating a VM Cluster

  • Creating a BMS Cluster

  • Connecting to a Kubernetes Cluster Using kubectl

  • Configuring kube-dns/CoreDNS HA Using kubectl

  • Creating a Node in a VM Cluster

  • Cluster Auto Scaling

  • Changing Cluster Specifications

  • Managing Node Labels

  • Deleting a Cluster

  • Cluster Statuses

  • Monitoring a Node

  • Managing Namespaces

• Application Management

  • Application Overview

  • Creating a Stateless Application

  • Creating a Stateful Application

  • Basic Operations on Applications

  • Setting Container Specifications

  • Setting Container Lifecycle

  • Setting Container Startup Command

  • Checking the Health of Containers

  • Affinity and Anti-Affinity Scheduling

  • Application Scaling

  • Using a Third-party Image to Create an Application

• Application Access Settings

  • Overview

  • Intra-Cluster Access

  • Intra-VPC Access

  • External Access - Elastic IP Address

  • External Access - Elastic Load Balancer

  • Layer 7 Load Balancing (Ingress)

• Job Management

  • Creating a One-off Jobs

  • Creating a Cron Job

  • Setting Container Startup Command

• Configuration Center

  • Creating a Configuration Item

  • Using a Configuration Item

  • Creating a Secret

  • Using a Secret

• Storage Management

  • Overview

  • Using Local Hard Disks

  • Using EVS Disks

  • Using SFS File Systems

• Log Management

  • Collecting Standard Output Logs of Containers

  • Collecting Logs in a Specified Path of a Container

• Container Orchestration

  • Basic Concepts

  • Preparing a Template Package

  • Uploading a Template Package

  • Creating an Application Using Template

  • Using an EVS Disk

  • Using Load Balancers

  • Upgrading a Template-based Application

  • Rolling Back a Template-based Application

  • Uninstalling Template-based Applications

• Image Repository

  • Creating an Organization

  • Creating an Image Repository

  • Connecting to the Private Container Registry

  • Uploading a Private Image from the Internet

  • Uploading a Private Image from an Intranet

  • Deleting an Image Repository or Image

  • Modifying an Image Repository

  • Viewing the Address of an Image Repository

  • Obtaining a Long-Term Valid Docker Login Command

• CTS

  • CCE Operations Supported by CTS

  • Querying CTS Logs

• Kubectl Usage Guide

• Data Migration from an Earlier Version to the Latest Version

  • Differences Between Versions

  • Migrating an Image

  • Migrating a Cluster

  • Migrating an Application

    • Applications Created Through API or kubectl

    • Applications Created Through Component Templates

    • Applications Created Through App Designer

• Reference

  • Formula for Calculating the Reserved Resources of a Node

  • How Do I Enable ICMP Security Group Rules?

  • Connecting to a Kubernetes Cluster Using Helm

• Change History

Documents Download

Video Tutorial