API Overview
APIs provided by CCE are classified as proprietary APIs and Kubernetes-native APIs. Using these APIs, you can use all functions provided by CCE, including creating clusters, 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, including creating and deleting clusters. You can use APIs in this category to create clusters and obtain information about created clusters. |
|
Manage add-ons, including querying AddonTemplates and creating, updating, deleting, and obtaining AddonInstances. |
||
Upgrade clusters, including performing a pre-upgrade check and backing up cluster data. |
||
Obtain quotas of CCE resources. |
||
Manage tags, including adding and deleting resource tags of a cluster. |
||
Manage charts, including creating, updating, obtaining, and deleting charts and chart releases. |
||
Kubernetes-native APIs |
None |
For details about how to call Kubernetes-native APIs, see Kubernetes APIs. |
Kubernetes APIs
API |
Function |
URI |
---|---|---|
Node |
Reading a specified node |
GET /api/v1/nodes/{name} |
Listing all nodes |
GET /api/v1/nodes |
|
Updating a specified node |
PATCH /api/v1/nodes/{name} |
|
Namespace |
Creating a namespace |
POST /api/v1/namespaces |
Deleting a namespace |
DELETE /api/v1/namespaces/{name} |
|
Querying a specified namespace |
GET /api/v1/namespaces/{name} |
|
Replacing a specified namespace |
PUT /api/v1/namespaces/{name} |
|
Replacing the status of a specified namespace |
PUT /api/v1/namespaces/{name}/status |
|
Replacing the finalize values of a specified namespace |
PUT /api/v1/namespaces/{name}/finalize |
|
Listing namespaces |
GET /api/v1/namespaces |
|
Updating a specified namespace |
PATCH /api/v1/namespaces/{name} |
|
Resourcequotas |
Querying resource quotas |
GET /api/v1/resourcequotas |
Creating a resource quota |
POST /api/v1/namespaces/{namespace}/resourcequotas |
|
Updating a resource quota |
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name} |
|
Deleting a resource quota |
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name} |
|
Pod |
Creating a pod |
POST /api/v1/namespaces/{namespace}/pods |
Deleting a pod |
DELETE /api/v1/namespaces/{namespace}/pods/{name} |
|
Deleting all pods |
DELETE /api/v1/namespaces/{namespace}/pods |
|
Reading a specified pod |
GET /api/v1/namespaces/{namespace}/pods/{name} |
|
Replacing a specified pod |
PUT /api/v1/namespaces/{namespace}/pods/{name} |
|
Replacing the status of a specified pod |
PUT /api/v1/namespaces/{namespace}/pods/{name}/status |
|
Listing all pods in a specified namespace |
GET /api/v1/namespaces/{namespace}/pods |
|
Listing pods |
GET /api/v1/pods |
|
Updating a specified pod |
PATCH /api/v1/namespaces/{namespace}/pods/{name} |
|
Deployment |
Creating a Deployment |
POST /apis/apps/v1/namespaces/{namespace}/deployments |
Rolling back a Deployment |
PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name} |
|
Deleting a Deployment |
DELETE /apis/apps/v1/namespaces/{namespace}/deployments/{name} |
|
Deleting all Deployments |
DELETE /apis/apps/v1/namespaces/{namespace}/deployments |
|
Reading a specified Deployment |
GET /apis/apps/v1/namespaces/{namespace}/deployments/{name} |
|
Reading the status of a specified Deployment |
GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status |
|
Reading the scaling operation of a specified Deployment |
GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale |
|
Replacing a specified Deployment |
PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name} |
|
Replacing the status of a specified Deployment |
PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status |
|
Replacing the scaling operation of a specified Deployment |
PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale |
|
Listing Deployments in a specified namespace |
GET /apis/apps/v1/namespaces/{namespace}/deployments |
|
Listing all Deployments |
GET /apis/apps/v1/deployments |
|
Updating a specified Deployment |
PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name} |
|
Updating the status of a specified Deployment |
PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status |
|
Updating the scaling operation of a specified Deployment |
PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale |
|
StatefulSet |
Creating a StatefulSet |
POST /apis/apps/v1/namespaces/{namespace}/statefulsets |
Deleting a specified StatefulSet |
DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} |
|
Deleting all StatefulSets |
DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets |
|
Reading a specified StatefulSet |
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} |
|
Reading the status of a specified StatefulSet |
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status |
|
Replacing a specified StatefulSet |
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} |
|
Replacing the status of a specified StatefulSet |
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status |
|
Listing StatefulSets in a specified namespace |
GET /apis/apps/v1/namespaces/{namespace}/statefulsets |
|
Listing all StatefulSets |
GET /apis/apps/v1/statefulsets |
|
Updating a specified StatefulSet |
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name} |
|
Updating the status of a specified StatefulSet |
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status |
|
Job |
Creating a job |
POST /apis/batch/v1/namespaces/{namespace}/jobs |
Deleting a job |
DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name} |
|
Deleting all jobs |
DELETE /apis/batch/v1/namespaces/{namespace}/jobs |
|
Reading a specified job |
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name} |
|
Reading the status of a specified job |
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status |
|
Replacing a specified job |
PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name} |
|
Replacing the status of a specified job |
PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status |
|
Listing jobs in a specified namespace |
GET /apis/batch/v1/namespaces/{namespace}/jobs |
|
Listing all jobs |
GET /apis/batch/v1/jobs |
|
Updating the status of a specified job |
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status |
|
Updating a specified job |
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name} |
|
CronJob |
Creating a cron job |
POST /apis/batch/v1/namespaces/{namespace}/cronjobs |
Deleting a cron job |
DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} |
|
Deleting all cron jobs |
DELETE /apis/batch/v1/namespaces/{namespace}/cronjobs |
|
Reading a specified cron job |
GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} |
|
Reading the status of a specified cron job |
GET /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status |
|
Replacing a specified cron job |
PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} |
|
Replacing the status of a specified cron job |
PUT /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status |
|
Listing cron jobs under a specified namespace |
GET /apis/batch/v1/namespaces/{namespace}/cronjobs |
|
Listing all cron jobs |
GET /apis/batch/v1/cronjobs |
|
Updating the status of a specified cron job |
PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status |
|
Updating a specified cron job |
PATCH /apis/batch/v1/namespaces/{namespace}/cronjobs/{name} |
|
ReplicaSet |
Listing ReplicaSets |
GET /apis/apps/v1/namespaces/{namespace}/replicasets |
Reading a specified ReplicaSet |
GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name} |
|
Listing all ReplicaSets |
GET /apis/apps/v1/replicasets |
|
ReplicationController |
Creating a ReplicationController |
POST /api/v1/namespaces/{namespace}/replicationcontrollers |
Deleting a ReplicationController |
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name} |
|
Deleting all ReplicationControllers |
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers |
|
Reading a ReplicationController under a specified namespace |
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name} |
|
Replacing a ReplicationController under a specified namespace |
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name} |
|
Replacing the status of a ReplicationController under a specified namespace |
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status |
|
Listing ReplicationControllers in a specified namespace |
GET /api/v1/namespaces/{namespace}/replicationcontrollers |
|
Listing ReplicationControllers |
GET /api/v1/replicationcontrollers |
|
Updating a specified ReplicationController |
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name} |
|
Endpoints |
Creating an endpoint |
POST /api/v1/namespaces/{namespace}/endpoints |
Deleting an endpoint |
DELETE /api/v1/namespaces/{namespace}/endpoints/{name} |
|
Deleting all endpoints |
DELETE /api/v1/namespaces/{namespace}/endpoints |
|
Querying a specified endpoint |
GET /api/v1/namespaces/{namespace}/endpoints/{name} |
|
Replacing a specified endpoint |
PUT /api/v1/namespaces/{namespace}/endpoints/{name} |
|
Listing endpoints |
GET /api/v1/endpoints |
|
Listing endpoints in a specified namespace |
GET /api/v1/namespaces/{namespace}/endpoints |
|
Updating a specified endpoint |
PATCH /api/v1/namespaces/{namespace}/endpoints/{name} |
|
Service |
Creating a Service |
POST /api/v1/namespaces/{namespace}/services |
Deleting a specified Service |
DELETE /api/v1/namespaces/{namespace}/services/{name} |
|
Obtaining a specified Service |
GET /api/v1/namespaces/{namespace}/services/{name} |
|
Replacing a specified Service |
PUT /api/v1/namespaces/{namespace}/services/{name} |
|
Listing Services in a specified namespace |
GET /api/v1/namespaces/{namespace}/services |
|
Listing Services |
GET /api/v1/services |
|
Updating a specified Service |
PATCH /api/v1/namespaces/{namespace}/services/{name} |
|
Ingress |
Creating an ingress |
POST /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses |
Updating a specified ingress |
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} |
|
Replacing a specified ingress |
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} |
|
Deleting an ingress |
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} |
|
Deleting all ingresses |
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses |
|
Obtaining a specified ingress |
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name} |
|
Listing ingresses in a specified namespace |
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses |
|
Listing ingresses |
GET /apis/networking.k8s.io/v1/ingresses |
|
Obtaining the status of an ingress in a specified namespace |
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status |
|
Replacing the status of an ingress in a specified namespace |
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status |
|
Updating the status of an ingress in a specified namespace |
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status |
|
NetworkPolicy |
Creating a network policy |
POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies |
Updating a specified network policy |
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} |
|
Replacing a specified network policy |
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} |
|
Deleting a specified network policy |
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} |
|
Deleting network policies in batches |
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies |
|
Reading a specified network policy |
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name} |
|
Listing network policies in a specified namespace |
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies |
|
Listing all network policies |
GET /apis/networking.k8s.io/v1/networkpolicies |
|
PersistentVolume |
Creating a PersistentVolume |
POST /api/v1/persistentvolumes |
Deleting a specified PersistentVolume |
DELETE /api/v1/persistentvolumes/{name} |
|
Deleting all PersistentVolumes |
DELETE /api/v1/persistentvolumes |
|
Reading a specified PersistentVolume |
GET /api/v1/persistentvolumes/{name} |
|
Replacing a specified PersistentVolume |
PUT /api/v1/persistentvolumes/{name} |
|
Replacing the status of a specified PersistentVolume |
PUT /api/v1/persistentvolumes/{name}/status |
|
Listing all PersistentVolumes |
GET /api/v1/persistentvolumes |
|
Updating a specified PersistentVolume |
PATCH /api/v1/persistentvolumes/{name} |
|
PersistentVolumeClaim |
Creating a PersistentVolumeClaim |
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims |
Deleting a specified PersistentVolumeClaim |
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} |
|
Deleting all PersistentVolumeClaims |
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims |
|
Reading a specified PersistentVolumeClaim |
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} |
|
Replacing a specified PersistentVolumeClaim |
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} |
|
Replacing the status of a specified PersistentVolumeClaim |
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status |
|
Listing PersistentVolumeClaims in a specified namespace |
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims |
|
Listing all PersistentVolumeClaims |
GET /api/v1/persistentvolumeclaims |
|
Updating a specified PersistentVolumeClaim |
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} |
|
ConfigMap |
Creating a ConfigMap |
POST /api/v1/namespaces/{namespace}/configmaps |
Deleting a ConfigMap |
DELETE /api/v1/namespaces/{namespace}/configmaps/{name} |
|
Deleting all ConfigMaps |
DELETE /api/v1/namespaces/{namespace}/configmaps |
|
Reading a specified ConfigMap |
GET /api/v1/namespaces/{namespace}/configmaps/{name} |
|
Replacing a specified ConfigMap |
PUT /api/v1/namespaces/{namespace}/configmaps/{name} |
|
Listing ConfigMaps in a specified namespace |
GET /api/v1/namespaces/{namespace}/configmaps |
|
Listing all ConfigMaps |
GET /api/v1/configmaps |
|
Updating a specified ConfigMap |
PATCH /api/v1/namespaces/{namespace}/configmaps/{name} |
|
Secret |
Creating a secret |
POST /api/v1/namespaces/{namespace}/secrets |
Deleting a secret |
DELETE /api/v1/namespaces/{namespace}/secrets/{name} |
|
Deleting all secrets in a specified namespace |
DELETE /api/v1/namespaces/{namespace}/secrets |
|
Reading a specified secret |
GET /api/v1/namespaces/{namespace}/secrets/{name} |
|
Replacing a specified secret |
PUT /api/v1/namespaces/{namespace}/secrets/{name} |
|
Listing the secrets in a namespace |
GET /api/v1/namespaces/{namespace}/secrets |
|
Listing secrets in a cluster |
GET /api/v1/secrets |
|
RBAC/ ClusterRole |
Creating a ClusterRole |
POST /apis/rbac.authorization.k8s.io/v1/clusterroles |
Updating a specified ClusterRole |
PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} |
|
Replacing a specified ClusterRole |
PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} |
|
Deleting a specified ClusterRole |
DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} |
|
Deleting ClusterRoles in batches |
DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles |
|
Reading a specified ClusterRole |
GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name} |
|
Listing ClusterRoles |
GET /apis/rbac.authorization.k8s.io/v1/clusterroles |
|
RBAC/ ClusterRoleBinding |
Creating a ClusterRoleBinding |
POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings |
Updating a specified ClusterRoleBinding |
PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} |
|
Replacing a specified ClusterRoleBinding |
PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} |
|
Deleting a specified ClusterRoleBinding |
DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} |
|
Deleting ClusterRoleBindings in batches |
DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings |
|
Reading a specified ClusterRoleBinding |
GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name} |
|
Listing ClusterRoleBindings |
GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings |
|
RBAC/Role |
Creating a Role |
POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles |
Updating a specified Role |
PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} |
|
Replacing a specified Role |
PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} |
|
Deleting a specified Role |
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} |
|
Deleting Roles in batches |
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles |
|
Reading a specified Role |
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name} |
|
Listing Roles in a specified namespace |
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles |
|
Listing all Roles |
GET /apis/rbac.authorization.k8s.io/v1/roles |
|
RBAC/RoleBinding |
Creating a RoleBinding |
POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings |
Updating a specified RoleBinding |
PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} |
|
Replacing a specified RoleBinding |
PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} |
|
Deleting a specified RoleBinding |
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} |
|
Deleting RoleBindings in batches |
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings |
|
Reading a specified RoleBinding |
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name} |
|
Listing RoleBindings in a specified namespace |
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings |
|
Listing all RoleBindings |
GET /apis/rbac.authorization.k8s.io/v1/rolebindings |
|
API groups |
Listing APIVersions |
GET /api |
Listing APIGroups |
GET /apis |
|
listing APIResources of GroupVersion apiregistration.k8s.io/v1beta1 |
GET /apis/apiregistration.k8s.io/v1beta1 |
|
listing APIResources of GroupVersion extensions/v1beta1 |
GET /apis/extensions/v1beta1 |
|
listing APIResources of GroupVersion apps/v1&apps/v1beta1 |
GET /apis/apps/v1 |
|
listing APIResources of GroupVersion authentication.k8s.io/v1 |
GET /apis/authentication.k8s.io/v1 |
|
listing APIResources of GroupVersion authentication.k8s.io/v1beta1 |
GET /apis/authentication.k8s.io/v1beta1 |
|
listing APIResources of GroupVersion authorization.k8s.io/v1 |
GET /apis/authorization.k8s.io/v1 |
|
listing APIResources of GroupVersion authorization.k8s.io/v1beta1 |
GET /apis/authorization.k8s.io/v1beta1 |
|
listing APIResources of GroupVersion autoscaling/v1 |
GET /apis/autoscaling/v1 |
|
listing APIResources of GroupVersion batch/v1 |
GET /apis/batch/v1 |
|
listing APIResources of GroupVersion certificates.k8s.io/v1beta1 |
GET /apis/certificates.k8s.io/v1beta1 |
|
listing APIResources of GroupVersion networking.k8s.io/v1 |
GET /apis/networking.k8s.io/v1 |
|
listing APIResources of GroupVersion policy/v1beta1 |
GET /apis/policy/v1beta1 |
|
listing APIResources of GroupVersion rbac.authorization.k8s.io/v1beta1 |
GET /apis/rbac.authorization.k8s.io/v1beta1 |
|
listing APIResources of GroupVersion storage.k8s.io/v1 |
GET /apis/storage.k8s.io/v1 |
|
listing APIResources of GroupVersion storage.k8s.io/v1beta1 |
GET /apis/storage.k8s.io/v1beta1 |
|
listing APIResources of GroupVersion apiextensions.k8s.io/v1beta1 |
GET /apis/apiextensions.k8s.io/v1beta1 |
|
listing APIResources of GroupVersion v1 |
GET /api/v1 |
|
Event |
Reading events |
GET /api/v1/events |
Listing events in a specified namespace |
GET /api/v1/namespaces/{namespace}/events |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot