CLI Command Reference (V1)
API groups
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying API Versions | hcloud CCI getCoreAPIVersions/v1 | get available API versions | |
| Querying All APIs of v1 | hcloud CCI getCoreV1APIResources/v1 | get available resources | |
| Querying an APIGroupList | hcloud CCI getAPIVersions/v1 | get available API versions | |
| Querying APIGroup (/apis/apps) | hcloud CCI getAppsAPIGroup/v1 | This API is used to query an APIGroup (/apis/apps). | |
| Querying APIs of apps/v1 | hcloud CCI getAppsV1APIResources/v1 | get available resources | |
| Querying an APIGroup (/apis/batch) | hcloud CCI getBatchAPIGroup/v1 | This API is used to query an APIGroup (/apis/batch). | |
| Querying an APIGroup (/apis/batch.volcano.sh) | hcloud CCI getBatchVolcanoShAPIGroup/v1 | This API is used to query an APIGroup (/apis/batch.volcano.sh). | |
| Querying All APIs of batch.volcano.sh/v1alpha1 | hcloud CCI getBatchVolcanoShV1alpha1APIResources/v1 | This API is used to query all APIs of batch.volcano.sh/v1alpha1. | |
| Querying All APIs of batch/v1 | hcloud CCI getBatchV1APIResources/v1 | get available resources | |
| Querying All APIs of batch/v1beta1 | hcloud CCI getBatchV1beta1APIResources/v1 | get available resources | |
| Querying an APIGroup (/apis/crd.yangtse.cni) | hcloud CCI getCrdYangtseCniAPIGroup/v1 | This API is used to query an APIGroup (/apis/crd.yangtse.cni). | |
| Querying All APIs of crd.yangtse.cni/v1 | hcloud CCI getCrdYangtseCniV1APIResources/v1 | This API is used to query all APIs of crd.yangtse.cni/v1. | |
| Querying an APIGroup (/apis/extensions) | hcloud CCI getExtensionsAPIGroup/v1 | This API is used to query an APIGroup (/apis/extensions). | |
| Querying All APIs of extensions/v1beta1 | hcloud CCI getExtensionsV1beta1APIResources/v1 | get available resources | |
| Querying an APIGroup (/apis/metrics.k8s.io) | hcloud CCI getMetricsAPIGroup/v1 | This API is used to query an APIGroup (/apis/metrics.k8s.io). | |
| Querying All APIs of metrics.k8s.io/v1beta1 | hcloud CCI getMetricsV1beta1APIResources/v1 | get available resources | |
| Querying an APIGroup (/apis/networking.cci.io) | hcloud CCI getNetworkingCciIoAPIGroup/v1 | This API is used to query an APIGroup (/apis/networking.cci.io). | |
| Querying All APIs of networking.cci.io/v1beta1 | hcloud CCI getNetworkingCciIoV1beta1APIResources/v1 | get available resources | |
| Querying an APIGroup (/apis/rbac.authorization.k8s.io) | hcloud CCI getRbacAuthorizationAPIGroup/v1 | get information of a group | |
| Querying All APIs of rbac.authorization.k8s.io/v1 | hcloud CCI getRbacAuthorizationV1APIResources/v1 | get available resources |
Namespace
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying All Namespaces | hcloud CCI listCoreV1Namespace/v1 | This API is used to query the details about all namespaces in the current project. | |
| Creating a Namespace | hcloud CCI createCoreV1Namespace/v1 | This API is used to create a namespace. | |
| Deleting a Namespace | hcloud CCI deleteCoreV1Namespace/v1 | This API is used to delete a specified namespace. | |
| Querying a Namespace | hcloud CCI readCoreV1Namespace/v1 | This API is used to query the details about a specified namespace. |
ConfigMap
| API Name | Command | Description | Operation |
|---|---|---|---|
| Deleting ConfigMaps in a Namespace | hcloud CCI deleteCoreV1CollectionNamespacedConfigMap/v1 | This API is used to delete all ConfigMaps in a specified namespace. | |
| Querying ConfigMaps in a Namespace | hcloud CCI listCoreV1NamespacedConfigMap/v1 | This API is used query the details about all ConfigMaps in a specified namespace. | |
| Creating a ConfigMap | hcloud CCI createCoreV1NamespacedConfigMap/v1 | This API is used to create a ConfigMap. | |
| Deleting a ConfigMap | hcloud CCI deleteCoreV1NamespacedConfigMap/v1 | This API is used to delete a specified ConfigMap. | |
| Querying a ConfigMap | hcloud CCI readCoreV1NamespacedConfigMap/v1 | This API is used to query the details about a specified ConfigMap. | |
| Updating a ConfigMap | hcloud CCI patchCoreV1NamespacedConfigMap/v1 | This API is used to update a specified ConfigMap. | |
| Replacing a ConfigMap | hcloud CCI replaceCoreV1NamespacedConfigMap/v1 | This API is used to update a specified ConfigMap. |
Endpoint
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Endpoints in a Namespace | hcloud CCI listCoreV1NamespacedEndpoints/v1 | This API is used to query all endpoints in a specified namespace. | |
| Creating an Endpoint | hcloud CCI createCoreV1NamespacedEndpoints/v1 | This API is used to create an endpoint. | |
| Deleting an Endpoint | hcloud CCI deleteCoreV1NamespacedEndpoints/v1 | This API is used to delete an endpoint. | |
| Querying an Endpoint | hcloud CCI readCoreV1NamespacedEndpoints/v1 | This API is used to query a specified endpoint. | |
| Updating an Endpoint | hcloud CCI patchCoreV1NamespacedEndpoints/v1 | This API is used to update an endpoint. | |
| Replacing an Endpoint | hcloud CCI replaceCoreV1NamespacedEndpoints/v1 | This API is used to replace an endpoint. |
Event
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Events in a Namespace | hcloud CCI listCoreV1NamespacedEvent/v1 | This API is used to query the details about all events in a specified namespace. | |
| Deleting an Event | hcloud CCI deleteCoreV1NamespacedEvent/v1 | This API is used to delete a specified event. | |
| Querying an Event | hcloud CCI readCoreV1NamespacedEvent/v1 | This API is used query the details about a specified event. |
PersistentVolumeClaim
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying PVCs in a Namespace | hcloud CCI listCoreV1NamespacedPersistentVolumeClaim/v1 | This API is used to query all PersistentVolumeClaims (PVCs) in a specified namespace. | |
| Creating a PVC | hcloud CCI createCoreV1NamespacedPersistentVolumeClaim/v1 | This API is used to dynamically create a PVC. If no storage resources are available, a storage resource is automatically created when there is a request for creating a PVC. | |
| Deleting a PVC | hcloud CCI deleteCoreV1NamespacedPersistentVolumeClaim/v1 | This API is used to delete a PVC. | |
| Querying a PVC | hcloud CCI readCoreV1NamespacedPersistentVolumeClaim/v1 | This API is used to query a specified PVC. | |
| Replacing PVCs | hcloud CCI replaceCoreV1NamespacedPersistentVolumeClaim/v1 | This API is used to replacing a specified PVC. |
Pod
| API Name | Command | Description | Operation |
|---|---|---|---|
| Deleting Pods in a Namespace | hcloud CCI deleteCoreV1CollectionNamespacedPod/v1 | This API is used to delete all pods in a specified namespace. | |
| Querying Pods in a Namespace | hcloud CCI listCoreV1NamespacedPod/v1 | This API is used to query details about pods in a specified namespace. | |
| Creating a Pod | hcloud CCI createCoreV1NamespacedPod/v1 | This API is used to create a pod. | |
| Deleting a Pod | hcloud CCI deleteCoreV1NamespacedPod/v1 | This API is used to delete a pod. Wait for 10s before the deletion. | |
| Querying a Pod | hcloud CCI readCoreV1NamespacedPod/v1 | This API is used to query the details about a specified pod. | |
| Updating a Pod | hcloud CCI patchCoreV1NamespacedPod/v1 | This API is used to update a specified pod. | |
| Replacing a Pod | hcloud CCI replaceCoreV1NamespacedPod/v1 | This API is used to replace a specified pod. | |
| Running Commands in a Container | hcloud CCI connectCoreV1GetNamespacedPodExec/v1 | This API is used to run commands in a container. | |
| Running Commands in a Container | hcloud CCI connectCoreV1PostNamespacedPodExec/v1 | This API is used to run commands in a container. | |
| Querying Pod Logs | hcloud CCI readCoreV1NamespacedPodLog/v1 | This API is used to query the logs of a specified pod. | |
| Querying the Status of a Pod | hcloud CCI readCoreV1NamespacedPodStatus/v1 | This API is used to query the status of a specified pod. | |
| Querying All Pods | hcloud CCI listCoreV1PodForAllNamespaces/v1 | This API is used to query all pods. |
ResourceQuota
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying resourcequotas in a Namespace | hcloud CCI listCoreV1NamespacedResourceQuota/v1 | This API is used to query the resourcequotas in a specified namespace. | |
| Querying a resourcequota | hcloud CCI readCoreV1NamespacedResourceQuota/v1 | This API is used to query a specified resourcequota. |
Secret
| API Name | Command | Description | Operation |
|---|---|---|---|
| Deleting Secrets in a Namespace | hcloud CCI deleteCoreV1CollectionNamespacedSecret/v1 | This API is used to delete all secrets in a specified namespace. | |
| Querying Secrets in a Namespace | hcloud CCI listCoreV1NamespacedSecret/v1 | This API is used to query all secrets in a specified namespace. | |
| Creating a Secret | hcloud CCI createCoreV1NamespacedSecret/v1 | This API is used to create a secret that Kubernetes uses to process sensitive information. | |
| Deleting a Secret | hcloud CCI deleteCoreV1NamespacedSecret/v1 | This API is used to delete a secret. | |
| Querying a Secret | hcloud CCI readCoreV1NamespacedSecret/v1 | This API is used to query the details about a specified secret. | |
| Updating a Secret | hcloud CCI patchCoreV1NamespacedSecret/v1 | This API is used to update partial information about a specified secret. | |
| Replacing a Secret | hcloud CCI replaceCoreV1NamespacedSecret/v1 | This API is used to replace a specified secret. |
Service
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Services in a Namespace | hcloud CCI listCoreV1NamespacedService/v1 | This API is used to query the details about all Services in a specified namespace. | |
| Creating a Service | hcloud CCI createCoreV1NamespacedService/v1 | This API is used to create a Service. | |
| Deleting a Service | hcloud CCI deleteCoreV1NamespacedService/v1 | This API is used to delete a specified Service. | |
| Querying a Service | hcloud CCI readCoreV1NamespacedService/v1 | This API is used to query the details about a specified Service. | |
| Updating a Service | hcloud CCI patchCoreV1NamespacedService/v1 | This API is used to update a specified Service. | |
| Replacing a Service | hcloud CCI replaceCoreV1NamespacedService/v1 | This API is used to replace a specified Service. | |
| Querying the Status of a Service | hcloud CCI readCoreV1NamespacedServiceStatus/v1 | This API is used to query the status of a specified Service. |
Deployment
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying All Deployments | hcloud CCI listAppsV1DeploymentForAllNamespaces/v1 | This API is used to query all Deployments. | |
| Deleting All Deployments in a Namespace | hcloud CCI deleteAppsV1CollectionNamespacedDeployment/v1 | This API is used to delete all Deployments in a specified namespace. | |
| Querying Deployments in a Namespace | hcloud CCI listAppsV1NamespacedDeployment/v1 | This API is used to query the details about all Deployments in a specified namespace. | |
| Creating a Deployment | hcloud CCI createAppsV1NamespacedDeployment/v1 | This API is used to create a Deployment. | |
| Deleting a Deployment | hcloud CCI deleteAppsV1NamespacedDeployment/v1 | This API is used to delete a specified Deployment. | |
| Querying a Deployment | hcloud CCI readAppsV1NamespacedDeployment/v1 | This API is used to query the details about a specified Deployment. | |
| Updating a Deployment | hcloud CCI patchAppsV1NamespacedDeployment/v1 | This API is used to update a specified Deployment. | |
| Replacing a Deployment | hcloud CCI replaceAppsV1NamespacedDeployment/v1 | This API is used to replace a specified Deployment. | |
| Querying the Scaling Operation of a Specified Deployment | hcloud CCI readAppsV1NamespacedDeploymentScale/v1 | This API is used to query the scaling operation of a specified Deployment. | |
| Updating the Scaling Operation of a Specified Deployment | hcloud CCI patchAppsV1NamespacedDeploymentScale/v1 | This API is used to partially update scale of the specified Scale. | |
| Replacing the Scaling Operation of a Specified Deployment | hcloud CCI replaceAppsV1NamespacedDeploymentScale/v1 | This API is used to replace scale of the specified Scale. | |
| Querying the Status of a Deployment | hcloud CCI readAppsV1NamespacedDeploymentStatus/v1 | This API is used to query the status of a specified Deployment. |
ReplicaSet
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying ReplicaSets in a Namespace | hcloud CCI listAppsV1NamespacedReplicaSet/v1 | This API is used to read all ReplicaSets in a specified namespace. | |
| Querying a ReplicaSet | hcloud CCI readAppsV1NamespacedReplicaSet/v1 | This API is used to query the details about a specified ReplicaSet. |
StatefulSet
| API Name | Command | Description | Operation |
|---|---|---|---|
| Deleting StatefulSets in a Namespace | hcloud CCI deleteAppsV1CollectionNamespacedStatefulSet/v1 | This API is used to delete all StatefulSets in a specified namespace. | |
| Querying StatefulSets in a Namespace | hcloud CCI listAppsV1NamespacedStatefulSet/v1 | This API is used to query the details about all StatefulSets in a specified namespace. | |
| Creating a StatefulSet | hcloud CCI createAppsV1NamespacedStatefulSet/v1 | This API is used to create a StatefulSet. | |
| Deleting a StatefulSet | hcloud CCI deleteAppsV1NamespacedStatefulSet/v1 | This API is used to delete a specified StatefulSet. | |
| Querying a StatefulSet | hcloud CCI readAppsV1NamespacedStatefulSet/v1 | This API is used to query the details about a specified StatefulSet. | |
| Updating a StatefulSet | hcloud CCI patchAppsV1NamespacedStatefulSet/v1 | This API is used to update a specified StatefulSet. | |
| Replacing a StatefulSet | hcloud CCI replaceAppsV1NamespacedStatefulSet/v1 | This API is used to replace a specified StatefulSet. | |
| Querying the Status of a StatefulSet | hcloud CCI readAppsV1NamespacedStatefulSetStatus/v1 | This API is used to query the status of a specified StatefulSet. | |
| Querying All StatefulSets | hcloud CCI listAppsV1StatefulSetForAllNamespaces/v1 | This API is used to list all StatefulSet resource objects. |
VolcanoJob
| API Name | Command | Description | Operation |
|---|---|---|---|
| Deleting Volcano Jobs in a Specified Namespace | hcloud CCI deleteBatchVolcanoShV1alpha1CollectionNamespacedJob/v1 | This API is used to delete all Volcano jobs in a specified namespace. | |
| Querying Volcano Jobs in a Namespace | hcloud CCI listBatchVolcanoShV1alpha1NamespacedJob/v1 | This API is used to query all Volcano jobs in a specified namespace. | |
| Creating a Volcano Job | hcloud CCI createBatchVolcanoShV1alpha1NamespacedJob/v1 | This API is used to create a Volcano job. | |
| Deleting a Volcano Job | hcloud CCI deleteBatchVolcanoShV1alpha1NamespacedJob/v1 | This API is used to delete a specified Volcano job. | |
| Querying a Volcano Job | hcloud CCI readBatchVolcanoShV1alpha1NamespacedJob/v1 | This API is used to query the details about a specified Volcano job. | |
| Updating a Volcano Job | hcloud CCI patchBatchVolcanoShV1alpha1NamespacedJob/v1 | This API is used to update a specified Volcano job. | |
| Replacing a Volcano Job | hcloud CCI replaceBatchVolcanoShV1alpha1NamespacedJob/v1 | This API is used to replace a specified Volcano job. |
Job
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying All Jobs | hcloud CCI listBatchV1JobForAllNamespaces/v1 | This API is used to obtain a Job list. | |
| Deleting Jobs in a Namespace | hcloud CCI deleteBatchV1CollectionNamespacedJob/v1 | This API is used to delete all jobs in a specified namespace. | |
| Querying Jobs in a Namespace | hcloud CCI listBatchV1NamespacedJob/v1 | This API is used to query the details about all jobs in a specified namespace. | |
| Creating a Job | hcloud CCI createBatchV1NamespacedJob/v1 | This API is used to create a job. | |
| Deleting a Job | hcloud CCI deleteBatchV1NamespacedJob/v1 | This API is used to delete a specified job. | |
| Querying a Job | hcloud CCI readBatchV1NamespacedJob/v1 | This API is used to query the details about a specified job. | |
| Updating a Job | hcloud CCI patchBatchV1NamespacedJob/v1 | This API is used to update a specified job. | |
| Replacing a Job | hcloud CCI replaceBatchV1NamespacedJob/v1 | This API is used to replace a specified job. | |
| Querying the Status of a Job | hcloud CCI readBatchV1NamespacedJobStatus/v1 | This API is used to query the status of a specified job. |
CronJob
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying CronJobs in All Namespaces | hcloud CCI listBatchV1beta1CronJobForAllNamespaces/v1 | This API is used to query the details about all CronJobs in all namespaces. |
EIPPool
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying EIPPools in a Namespace | hcloud CCI listCrdYangtseCniV1NamespacedEIPPool/v1 | This API is used to query details about all EIPPools in a specified namespace. | |
| Creating an EIPPool | hcloud CCI createCrdYangtseCniV1NamespacedEIPPool/v1 | This API is used to create an EIPPool. | |
| Deleting an EIPPool | hcloud CCI deleteCrdYangtseCniV1NamespacedEIPPool/v1 | This API is used to delete a specified EIPPool. | |
| Querying an EIPPool | hcloud CCI readCrdYangtseCniV1NamespacedEIPPool/v1 | This API is used to query the details about a specified EIPPool. | |
| Updating an EIPPool | hcloud CCI patchCrdYangtseCniV1NamespacedEIPPool/v1 | This API is used to update an EIPPool. | |
| Replacing an EIPPool | hcloud CCI replaceCrdYangtseCniV1NamespacedEIPPool/v1 | This API is used to replace an EIPPool. | |
| Querying an EIPPool | hcloud CCI readCrdYangtseCniV1NamespacedEIPPoolStatus/v1 | This API is used to query the details about a specified EIPPool. |
Ingress
| API Name | Command | Description | Operation |
|---|---|---|---|
| Deleting Ingresses in a Namespace | hcloud CCI deleteExtensionsV1beta1CollectionNamespacedIngress/v1 | This API is used to delete all ingresses in a specified namespace. | |
| Querying Ingresses in a Namespace | hcloud CCI listExtensionsV1beta1NamespacedIngress/v1 | This API is used to query the details about all ingresses in a specified namespace. | |
| Creating an Ingress | hcloud CCI createExtensionsV1beta1NamespacedIngress/v1 | This API is used to create an HTTP ingress. The associated backend service is Redis:8080. A load balancer from ELB is used as the ingress controller. The IP address of the load balancer is 192.168.137.182, and the port number is 6071. | |
| Deleting an Ingress | hcloud CCI deleteExtensionsV1beta1NamespacedIngress/v1 | This API is used to delete a specified ingress. | |
| Querying an Ingress | hcloud CCI readExtensionsV1beta1NamespacedIngress/v1 | This API is used to query the details about a specified ingress. | |
| Updating an Ingress | hcloud CCI patchExtensionsV1beta1NamespacedIngress/v1 | This API is used to update a specified ingress. | |
| Replacing an Ingress | hcloud CCI replaceExtensionsV1beta1NamespacedIngress/v1 | This API is used to replace a specified ingress. | |
| Querying the Status of an Ingress | hcloud CCI readExtensionsV1beta1NamespacedIngressStatus/v1 | This API is used to query the status of a specified ingress. |
Metrics
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining Metrics of All Pods in a Namespace | hcloud CCI listMetricsV1beta1NamespacedPodMetrics/v1 | This API is used to obtain metrics of all pods in a specified namespace. | |
| Obtaining Metrics of a Pod | hcloud CCI readMetricsV1beta1NamespacedPodMetrics/v1 | This API is used to obtain metrics of a specified pod in a specified namespace. |
Network
| API Name | Command | Description | Operation |
|---|---|---|---|
| Deleting Networks in a Namespace | hcloud CCI deleteNetworkingCciIoV1beta1CollectionNamespacedNetwork/v1 | This API is used to delete all networks in a specified namespace. | |
| Querying Networks in a Namespace | hcloud CCI listNetworkingCciIoV1beta1NamespacedNetwork/v1 | This API is used to list all networks in a specified namespace. | |
| Creating a Network | hcloud CCI createNetworkingCciIoV1beta1NamespacedNetwork/v1 | This API is used to create a network. | |
| Deleting a Network | hcloud CCI deleteNetworkingCciIoV1beta1NamespacedNetwork/v1 | This API is used to delete a specified network. | |
| Querying a Network | hcloud CCI readNetworkingCciIoV1beta1NamespacedNetwork/v1 | This API is used to query a specified network. | |
| Querying the Status of a Network | hcloud CCI readNetworkingCciIoV1beta1NamespacedNetworkStatus/v1 | This API is used to query the status of a specified network. |
ClusterRole
| API Name | Command | Description | Operation |
|---|---|---|---|
| Listing ClusterRoles | hcloud CCI listRbacAuthorizationV1ClusterRole/v1 | This API is used to list or watch objects of kind ClusterRole | |
| Querying a Cluster Role | hcloud CCI readRbacAuthorizationV1ClusterRole/v1 | This API is used to read the specified ClusterRole |
RoleBinding
| API Name | Command | Description | Operation |
|---|---|---|---|
| Listing RoleBindings in a Specified Namespace | hcloud CCI listRbacAuthorizationV1NamespacedRoleBinding/v1 | This API is used to list or watch objects of kind RoleBinding | |
| Creating a RoleBinding | hcloud CCI createRbacAuthorizationV1NamespacedRoleBinding/v1 | This API is used to create a RoleBinding | |
| Deleting a RoleBinding | hcloud CCI deleteRbacAuthorizationV1NamespacedRoleBinding/v1 | This API is used to delete a RoleBinding | |
| Querying a RoleBinding | hcloud CCI readRbacAuthorizationV1NamespacedRoleBinding/v1 | This API is used to read the specified RoleBinding | |
| Updating a RoleBinding | hcloud CCI patchRbacAuthorizationV1NamespacedRoleBinding/v1 | This API is used to partially update the specified RoleBinding | |
| Replacing a RoleBinding | hcloud CCI replaceRbacAuthorizationV1NamespacedRoleBinding/v1 | This API is used to replace the specified RoleBinding | |
| Listing RoleBindings | hcloud CCI listRbacAuthorizationV1RoleBindingForAllNamespaces/v1 | This API is used to list or watch objects of kind RoleBinding |
StorageClass
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying All Storage Classes in the /apis/storage.k8s.io/v1 Version | hcloud CCI listStorageV1StorageClass/v1 | list or watch objects of kind StorageClass | |
| Querying a Specified Storage Class | hcloud CCI readStorageV1StorageClass/v1 | read the specified StorageClass |
OpenAPIv2
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the OpenAPI Swagger | hcloud CCI GetOpenAPIv2/v1 | This API is used to query the OpenAPI Swagger. |
What is your overall rating for this page?
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.
For any further questions, feel free to contact us through the chatbot.
Chatbot