Help Center/ Cloud Container Instance (CCI)/ API Reference/ API Overview

Updated on 2026-02-25 GMT+08:00

View PDF

API Overview

CCI provides proprietary APIs for you to better manage resources. With these APIs, you can use all functions provided by CCI, such as creating a Deployment.

Subtype	Description
Namespace	Namespace management APIs, such as the APIs for creating, querying, updating, and deleting a namespace. A namespace provides a method of allocating resources among multiple users. When you have a large number of projects and personnel, you can define namespaces by project attributes, such as production, testing, and development.
Network	Network management APIs, such as the APIs for creating, querying, modifying, and deleting a network. Network is a new object added to CCI to define the mapping between the network in a namespace and the subnet and VPC.
Pod	Pod management APIs, such as the APIs for creating, querying, modifying, and deleting a pod. A pod is the smallest and simplest unit in the Kubernetes object model that you create or deploy. A pod encapsulates one or more containers, storage resources, an independent network IP address, and policies for managing container running.
Deployment	Deployment management APIs, such as the APIs for creating, querying, modifying, and deleting a Deployment. Deployment is a type of pod controller. A Deployment can contain one or more pod replicas. Each pod replica has the same role. Therefore, the system automatically distributes requests to multiple pod replicas of a Deployment. All pod replicas in a Deployment share storage volumes.
ReplicaSet	ReplicaSet management APIs, such as the API for querying a ReplicaSet. ReplicaSet is used to maintain the number of replicas for a group of pods to ensure that the specified number of pods are always running.
Service	Service management APIs, such as the APIs for creating, querying, modifying, and deleting a Service. A Service is an object that manages interfaces for exposing a collection of pods on the network. Each Service object defines a logical set of endpoints (usually pods) and a policy for accessing these pods.
ConfigMap	ConfigMap management APIs, such as the APIs for creating, querying, modifying, and deleting a ConfigMap. A ConfigMap is an API object used to save non-confidential data to key-value pairs. Pods can use it as an environment variable, a command line parameter, or a configuration file in storage volumes.
Secret	Secret management APIs, such as the APIs for creating, querying, modifying, and deleting a secret. A secret is similar to a ConfigMap but is used to store confidential data, such as passwords, tokens, or keys.
PersistentVolumeClaim	PersistentVolumeClaim management APIs, such as the APIs for creating, querying, modifying, and deleting a PersistentVolumeClaim. A PersistentVolumeClaim is a request for and claim to a PersistentVolume. Similar to a pod that requests CPU and memory, a PersistentVolumeClaim requests storage resources.
HorizontalPodAutoscaler	HorizontalPodoAutoscaler management APIs, such as the APIs for creating, querying, modifying, and deleting a HorizontalPodoAutoscaler. HorizontalPodoAutoscaler configures horizontal pod scaling. It automatically manages the number of replicas of a Deployment based on the specified metrics.

Namespace

API	Description
Creating a Namespace	Creates a namespace.
Querying a Namespace	Queries the details about a namespace.
Listing Namespaces	Queries the details about all namespaces of a tenant.
Deleting a Namespace	Deletes a namespace.

Network

API	Description
Listing Networks in a Namespace	Queries the details about all networks in a namespace.
Creates a network.	Creates a network.
Deleting a Network	Deletes a network in a namespace.
Querying a Network	Queries the details about a network in a namespace.
Updates a network.	Updates a network in a namespace.
Replaces a network.	Replaces a network in a namespace.

Pod

API	Description
Listing Pods in a Namespace	Queries the details about all pods in a namespace.
Creating a Pod	Creates a pod.
Deleting a Pod	Deletes a pod in a namespace.
Querying a Pod	Queries the details about a pod in a namespace.
Updating a Pod	Updates a pod in a namespace.
Replacing a Pod	Replaces a pod in a namespace.
Running Commands in a Container of a Pod	Runs commands in the containers of a pod in a namespace.
Querying Pod Logs	Queries the logs of a pod in a namespace.
Listing Pods	Queries the details about all pods of a tenant.

Deployment

API	Description
Listing Deployments	Queries the details about all Deployments of a tenant.
Listing Deployments in a Namespace	Queries the details about all Deployments in a namespace.
Creating a Deployment	Creates a Deployment.
Deleting a Deployment	Deletes a Deployment in a namespace.
Querying a Deployment	Queries the details about a Deployment in a namespace.
Updating a Deployment	Updates a Deployment in a namespace.
Replacing a Deployment	Replaces a Deployment in a namespace.

ReplicaSet

API	Description
Listing ReplicaSets in a Namespace	Queries the details about all ReplicaSets in a namespace.
Querying a ReplicaSet	Queries the details about a ReplicaSet in a namespace.

Service

API	Description
Listing Services in a Namespace	Queries the details about all Services in a namespace.
Creating a Service	Creates a Service.
Deleting a Service	Deletes a Service in a namespace.
Querying a Service	Queries the details about a Service in a namespace.
Updating a Service	Updates a Service in a namespace.
Replacing a Service	Replaces a Service in a namespace.

ConfigMap

API	Description
Listing ConfigMaps in a Namespace	Queries the details about all ConfigMaps in a namespace.
Creating a ConfigMap	Creates a ConfigMap.
Deletes a ConfigMap	Deletes a ConfigMap in a namespace.
Querying a ConfigMap	Queries the details about a ConfigMap in a namespace.
Updating a ConfigMap	Updates a ConfigMap in a namespace.
Replacing a ConfigMap	Replaces a ConfigMap in a namespace.

Secret

API	Description
Listing Secrets in a Namespace	Queries the details about all secrets in a namespace.
Creating a Secret	Creates a secret.
Deleting a Secret	Deletes a secret in a namespace.
Querying a Secret	Queries the details about a secret in a namespace.
Updating a Secret	Updates a secret in a namespace.
Replacing a Secret	Replaces a secret in a namespace.

PersistentVolumeClaim

API	Description
Listing PersistentVolumeClaims in a Namespace	Queries the details about all PersistentVolumeClaims in a namespace.
Creating a PersistentVolumeClaim	Creates a PersistentVolumeClaim.
Deleting a PersistentVolumeClaim	Deletes a PersistentVolumeClaim in a namespace.
Querying a PersistentVolumeClaim	Queries the details about a PersistentVolumeClaim in a namespace.
Updating a PersistentVolumeClaim	Updates a PersistentVolumeClaim in a namespace.
Replacing a PersistentVolumeClaim	Replaces a PersistentVolumeClaim in a namespace.

HorizontalPodAutoscaler

API	Description
Listing HorizontalPodAutoscalers in a Namespace	Queries the details about all HorizontalPodAutoscalers in a namespace.
Creating a HorizontalPodAutoscaler	Creates a HorizontalPodAutoscaler.
Deletes a HorizontalPodAutoscaler.	Deletes a HorizontalPodAutoscaler in a namespace.
Querying a HorizontalPodAutoscaler	Queries the details about a HorizontalPodAutoscaler in a namespace.
Updating a HorizontalPodAutoscaler	Updates a HorizontalPodAutoscaler in a namespace.
Replacing a HorizontalPodAutoscaler	Replaces a HorizontalPodAutoscaler in a namespace.

Previous topic: Before You Start

Next topic: Calling APIs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.