API Overview
APIs provided by CCE are classified into two types: proprietary APIs and Kubernetes-native APIs. By using these two types of APIs, you can use all functions provided by CCE, including creating clusters and nodes, using the Kubernetes-native APIs to create workloads, and using the proprietary CCE APIs to monitor application data.
|
Type |
Subtype |
Description |
|---|---|---|
|
Proprietary CCE APIs |
Manage clusters and nodes, including creating and deleting clusters and nodes. Using these APIs, you can create clusters, add nodes to clusters, and obtain information about created clusters and nodes.
NOTICE:
When performing operations, such as creating, deleting, and scaling clusters, do not change user permission in the IAM console. Otherwise, these operations may fail. |
|
|
Manage storage, including creating and deleting PersistentVolumeClaims and PersistentVolumes. |
||
|
Manage add-ons, including querying AddonTemplates and creating, updating, deleting, and obtaining AddonInstances. |
||
|
Kubernetes-native APIs |
Manage nodes, such as obtaining, querying, and updating nodes.
NOTE:
CCE allows you to create and delete nodes using only APIs of cluster management. Using Kubernetes-native APIs to create or delete nodes is not supported. |
|
|
Manage namespaces, such as creating, querying, modifying, and deleting namespaces. |
||
|
Query resource quotas. |
||
|
Manage pods, such as creating, querying, modifying, and deleting pods. |
||
|
Manage Deployments, such as creating, querying, modifying, and deleting Deployments. |
||
|
Manage StatefulSets, such as creating, querying, modifying, and deleting StatefulSets. |
||
|
Manage DaemonSets, such as creating, querying, modifying, and deleting DaemonSets. |
||
|
Manage jobs, such as creating, querying, modifying, and deleting jobs. |
||
|
Manage cron jobs, including creating, querying, modifying, and deleting cron jobs. |
||
|
Query ReplicaSets. |
||
|
Manage ReplicationController objects, including creating, querying, modifying, and deleting ReplicationController objects. |
||
|
Manage endpoints, such as creating, querying, modifying, and deleting endpoints. |
||
|
Manage Service objects, such as creating, querying, modifying, and deleting Service objects. |
||
|
Manage ingresses, including creating, updating, and deleting ingresses. |
||
|
Manage network policies, including creating, updating, and deleting network policies. |
||
|
Manage PersistentVolumes (PVs), such as creating, querying, modifying, and deleting PVs. |
||
|
Manage PersistentVolumeClaims (PVCs), such as creating, querying, modifying, and deleting PVCs. |
||
|
Manage ConfigMaps, such as creating, querying, modifying, and deleting ConfigMaps. |
||
|
Manage secrets, including creating, querying, modifying, and deleting secrets. |
||
|
Authorize users or user groups to perform operations on different Kubernetes resources. |
||
|
Manage API groups, including listing API groups and API versions. |
||
|
Query events. |
The Kubernetes-native APIs called in the current version do not support HTTP persistent connections.
Cluster-related APIs
|
API |
Description |
|---|---|
|
Create an empty cluster, which has only master nodes but do not have worker nodes. |
|
|
Obtain details about a specified cluster. |
|
|
Obtain details about all clusters in a specified project. |
|
|
Update information about a specified cluster. |
|
|
Delete a specified cluster. |
|
|
Hibernate a specified cluster. |
|
|
Wake up a hibernated cluster. |
|
|
Obtain certificates of a specified cluster. |
|
|
Create a node in a specified cluster. |
|
|
Obtain details about a node with a specified node ID. |
|
|
Obtain details about all nodes in a cluster with a specified cluster ID. |
|
|
Update information about a specified node. |
|
|
Delete a specified node |
|
|
Create a node pool in a specified cluster. |
|
|
Obtain details about a specified node pool. |
|
|
Obtain information about all node pools in a specified cluster. |
|
|
Update information about a specified node pool. |
|
|
Delete a specified node pool. |
|
|
Obtain the progress of a job with a specified job ID returned after a job request is issued. |
Storage-related APIs
|
API |
Description |
|---|---|
|
Create a PersistentVolumeClaim (PVC) in a specified namespace in HUAWEI CLOUD. The PVC is a request for a PersistentVolume (PV) that carries details of real cloud storage such as EVS disks, SFS file systems, or OBS buckets. |
|
|
Delete a PVC from a specified namespace. It is user's choice whether to retain the real cloud storage bound to the PVC. |
Add-on-related APIs
|
API |
Description |
|---|---|
|
Install an add-on by using the add-on template. One or more instances will be created for the installed add-on. |
|
|
Query add-on information. |
|
|
Update an add-on instance. |
|
|
Delete an add-on instance. |
|
|
Obtain details about an add-on instance. |
|
|
List all add-on instances in the cluster. |
Node-related APIs
|
API |
Description |
|---|---|
|
Read a specified node. |
|
|
Obtain the list of specified nodes. |
|
|
Update a specified node. |
Namespace-related APIs
|
API |
Description |
|---|---|
|
Create a namespace. |
|
|
Delete a namespace. |
|
|
Obtain details about a specified namespace. |
|
|
Replace some information about a specified namespace. |
|
|
Modify the status information of a specified namespace. |
|
|
Replace the finalize value of a specified namespace. |
|
|
Obtain details about all namespaces in a cluster. |
|
|
Update some information about a specified namespace. |
Resource Quota-related APIs
|
API |
Description |
|---|---|
|
List or query detailed information about resource quotas. |
Pod-related APIs
|
API |
Description |
|---|---|
|
Create a pod in a specified namespace. |
|
|
Delete a pod in a specified namespace. |
|
|
Delete all pods. |
|
|
Obtain details about a specified pod in a specified namespace. |
|
|
Replace a pod in a specified namespace. |
|
|
Change the status of a ReplicationController in a specified namespace. |
|
|
List all pods in a specified namespace. |
|
|
Obtain a pod list. |
|
|
Update a pod in a specified namespace. |
Deployment-related APIs
|
API |
Description |
|---|---|
|
Create a Deployment. |
|
|
Create a Deployment rollback operation. |
|
|
Delete a Deployment. |
|
|
Delete all Deployments. |
|
|
Obtain a specified Deployment in a namespace. |
|
|
Obtain the status of a specified Deployment in a namespace. |
|
|
Obtain details about scaling a specified Deployment. |
|
|
Replace a specified Deployment. |
|
|
Change the value of the status field of a specified Deployment in a specified namespace. |
|
|
Replace the scaling operation of a specified Deployment. |
|
|
List all Deployments in a specified namespace. |
|
|
List specified Deployments. |
|
|
Update a Deployment in a specified namespace. |
|
|
Update the status of a specified Deployment in a specified namespace. |
|
|
Update the scaling operation of a specified Deployment. |
StatefulSet-related APIs
|
API |
Description |
|---|---|
|
Create a StatefulSet. |
|
|
Delete a StatefulSet. |
|
|
Delete all StatefulSets. |
|
|
Obtain StatefulSets in a specified namespace. |
|
|
Obtain the status of a specified StatefulSet in a specified namespace. |
|
|
Replace StatefulSets in a specified namespace. |
|
|
Change the value of the status field of a specified StatefulSet in a specified namespace. |
|
|
List all StatefulSets in a specified namespace. |
|
|
List all StatefulSets. |
|
|
Update StatefulSets in a specified namespace. |
|
|
Update the status of a specified StatefulSet in a specified namespace. |
DaemonSet-related APIs
|
API |
Description |
|---|---|
|
Create a DaemonSet. |
|
|
Delete a DaemonSet. |
|
|
Delete all DaemonSets. |
|
|
Read a DaemonSet object in a specified namespace. |
|
|
Obtain the status of a specified DaemonSet in a specified namespace. |
|
|
Update a DaemonSet in a specified namespace. |
|
|
Update the status of a specified DaemonSet in a specified namespace. |
|
|
List specified DaemonSets. |
|
|
List all DaemonSets in a specified namespace. |
|
|
Replace DaemonSets in a specified namespace. |
|
|
Change the value of the status field of a specified DaemonSet in a specified namespace. |
Job-related APIs
|
API |
Description |
|---|---|
|
Create a job. |
|
|
Delete a job. |
|
|
Delete all jobs. |
|
|
Read a specified job. |
|
|
Obtain the status of a specified job. |
|
|
Replace a specified job. |
|
|
Replace the status of a specified job. |
|
|
List all jobs in a specified namespace. |
|
|
List all jobs. |
|
|
Update the status of a specified job in a specified namespace. |
|
|
Update a specified job. |
Cron Job-related APIs
|
API |
Description |
|---|---|
|
Create a cron job. |
|
|
Delete a cron job. |
|
|
Delete all cron jobs. |
|
|
Read a specified cron job. |
|
|
Read the status of a specified cron job. |
|
|
Replace a specified cron job. |
|
|
Replace the status of a specified cron job. |
|
|
List all cron jobs in a specified namespace. |
|
|
List all cron jobs. |
|
|
Update the status of a specified cron job in a specified namespace. |
|
|
Update a specified cron job. |
ReplicaSet-related APIs
|
API |
Description |
|---|---|
|
List all ReplicaSets in a specified namespace. |
ReplicationController-related APIs
|
API |
Description |
|---|---|
|
Create a ReplicationController. |
|
|
Delete a ReplicationController. |
|
|
Delete ReplicationControllers in batches. |
|
|
Obtain information about a ReplicationControllers in a specified namespace. |
|
|
Replacing a ReplicationController Under a Specified Namespace |
Replace a ReplicationController in a specified namespace. |
|
Replacing the Status of a ReplicationController Under a Specified Namespace |
Change the status of a ReplicationController in a specified namespace. |
|
List all ReplicationControllers in a specified namespace. |
|
|
Obtain a ReplicationController list. |
|
|
Update the ReplicationController in a specified namespace. |
Endpoint-related APIs
|
API |
Description |
|---|---|
|
Create an endpoint. |
|
|
Delete an endpoint. |
|
|
Delete all endpoints. |
|
|
Obtain details about a specified endpoint. |
|
|
Replace a specified endpoint in a specified namespace. |
|
|
List all endpoints. |
|
|
Obtain all endpoints in a specified namespace. |
|
|
Update endpoints in a specified namespace. |
Service-related APIs
|
API |
Description |
|---|---|
|
Create a Service. |
|
|
Delete a Service. |
|
|
Obtain a specified Service. |
|
|
Replace a specified Service. |
|
|
List Services in a specified namespace. |
|
|
List Services in a cluster. |
|
|
Replace a specified Service. |
Ingress-related APIs
|
API |
Description |
|---|---|
|
Create an ingress. |
|
|
Update a specified ingress partially. |
|
|
Replace a specified ingress. |
|
|
Delete an ingress. |
|
|
Delete all ingresses. |
|
|
Read a specified ingress. |
|
|
List ingresses in a specified namespace. |
|
|
Obtain the ingress list. |
|
|
Obtain the status of an ingress in a specified namespace. |
|
|
Replace the status of an ingress in a specified namespace. |
|
|
Update the status of an ingress in a specified namespace. |
Network Policy-related APIs
|
API |
Description |
|---|---|
|
Create a network policy. |
|
|
Partially update a specified network policy. |
|
|
Replace a specified network policy. |
|
|
Delete a network policy. |
|
|
Delete network policies in batches. |
|
|
Read a specified network policy. |
|
|
Obtaining the NetworkPolicy List Under a Specified Namespace |
List network policies in a specified namespace. |
|
Obtain the network policy list. |
PersistentVolume-related APIs
|
API |
Description |
|---|---|
|
Create a PersistentVolume. |
|
|
Delete a specified PersistentVolume. |
|
|
Delete all PersistentVolumes. |
|
|
Obtain details about a specified PersistentVolume. |
|
|
Replace a specified PersistentVolume. |
|
|
Replace the status of a specified PersistentVolume. |
|
|
List all PersistentVolumes. |
|
|
Update a specified PersistentVolume. |
PersistentVolumeClaim-related APIs
|
API |
Description |
|---|---|
|
Create a PersistentVolumeClaim in a specified namespace. |
|
|
Delete a PersistentVolumeClaim in a specified namespace. |
|
|
Delete all PersistentVolumeClaims. |
|
|
Obtain details about a PersistentVolumeClaim in a specified namespace. |
|
|
Replace a PersistentVolumeClaim in a specified namespace. |
|
|
Replace the status of a specified PersistentVolumeClaim in a specified namespace. |
|
|
List all PersistentVolumeClaims in a specified namespace. |
|
|
List all PersistentVolumeClaims. |
|
|
Update a specified PersistentVolumeClaim. |
ConfigMap-related APIs
|
API |
Description |
|---|---|
|
Create a ConfigMap. |
|
|
Delete a ConfigMap. |
|
|
Delete all ConfigMaps. |
|
|
Read a specified ConfigMap. |
|
|
Replace a specified ConfigMap. |
|
|
List all ConfigMaps in a specified namespace. |
|
|
Obtain the ConfigMap list. |
|
|
Update a specified ConfigMap. |
Secret-related APIs
|
API |
Description |
|---|---|
|
Create a secret. |
|
|
Delete secrets in a specified namespace. |
|
|
Delete secrets in batches. |
|
|
Obtain details about a specified secret. |
|
|
Replace secrets in a specified namespace. |
|
|
List secrets in a specified namespace. |
|
|
List all secrets in a cluster. |
RBAC-related APIs
|
API |
Description |
|---|---|
|
Create a ClusterRole. |
|
|
Partially update a specified ClusterRole. |
|
|
Replace a specified ClusterRole. |
|
|
Delete a specified ClusterRole. |
|
|
Batch delete ClusterRoles. |
|
|
Read a specified ClusterRole. |
|
|
Obtain the ClusterRole list. |
|
|
Create a ClusterRoleBinding. |
|
|
Partially update a specified ClusterRoleBinding. |
|
|
Replace a specified ClusterRoleBinding. |
|
|
Delete a specified ClusterRoleBinding. |
|
|
Batch delete ClusterRoleBindings. |
|
|
Read a specified ClusterRoleBinding. |
|
|
Obtain the ClusterRoleBinding list. |
|
|
Create a role. |
|
|
Partially update a specified role. |
|
|
Replace a specified role. |
|
|
Delete a specified role. |
|
|
Batch delete roles. |
|
|
Read a specified role. |
|
|
List roles in a specified namespace. |
|
|
Obtain the role list. |
|
|
Create a RoleBinding. |
|
|
Partially update a specified RoleBinding. |
|
|
Replace a specified RoleBinding. |
|
|
Delete a specified RoleBinding. |
|
|
Batch delete RoleBindings. |
|
|
Read a specified RoleBinding. |
|
|
Obtain the list of RoleBindings in a specified namespace. |
|
|
Obtain the RoleBinding list. |
API Group-related APIs
|
API |
Description |
|---|---|
|
List API versions. |
|
|
List API groups. |
|
|
listing APIResources of GroupVersion apiregistration.k8s.io/v1beta1 |
List API groups. |
|
List API groups. |
|
|
List the APIResources of Group Version "apps/v1beta1". |
|
|
listing APIResources of GroupVersion authentication.k8s.io/v1 |
List APIResources of GroupVersion "authentication.kubernetes.io/v1" |
|
listing APIResources of GroupVersion authentication.k8s.io/v1beta1 |
List APIResources of GroupVersion "authentication.k8s.io/v1beta1". |
|
listing APIResources of GroupVersion authorization.k8s.io/v1 |
List APIResources of GroupVersion "authorization.k8s.io/v1". |
|
listing APIResources of GroupVersion authorization.k8s.io/v1beta1 |
List APIResources of GroupVersion "authorization.k8s.io/v1beta1". |
|
List APIResources of GroupVersion "autoscaling/v1". |
|
|
List the APIResources of GroupVersion "batch/v1". |
|
|
listing APIResources of GroupVersion certificates.k8s.io/v1beta1 |
List the GroupVersion "certificates.k8s.io/v1beta1". |
|
List the APIResources of GroupVersion "networking.k8s.io/v1". |
|
|
List the APIResources of GroupVersion "policy/v1beta1". |
|
|
listing APIResources of GroupVersion rbac.authorization.k8s.io/v1beta1 |
List the APIResources of GroupVersion "rbac.authorization.k8s.io/v1beta1". |
|
List APIResources of GroupVersion "storage.k8s.io/v1". |
|
|
List APIResources of GroupVersion "storage.k8s.io/v1beta1". |
|
|
listing APIResources of GroupVersion apiextensions.k8s.io/v1beta1 |
List the APIResources of GroupVersion "apiextensions.k8s.io/v1beta1". |
|
List the APIResources of GroupVersion "v1". |
Event-related APIs
|
API |
Description |
|---|---|
|
List all events in a specified namespace. |
Last Article: Concepts
Next Article: Calling APIs
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.