文档首页 > > API参考> API概览

API概览

分享
更新时间:2020/09/18 GMT+08:00

云容器引擎所提供的接口分为CCE接口与Kubernetes原生接口。通过配合使用CCE接口和Kubernetes原生接口,您可以完整的使用云容器引擎的所有功能,包括创建集群和节点,使用Kubernetes接口创建容器工作负载,使用CCE接口监控工作负载的使用数据等。

类型

子类型

说明

CCE接口

集群管理

集群和节点管理接口,包括创建、删除集群和节点的接口等。

通过这些接口,您可以创建集群、为集群添加节点、获取已创建集群和节点的信息。

须知:

在创建、删除、扩容和缩容集群的操作中,请不要在统一身份认证服务(IAM)中执行权限变更或修改的操作,可能会导致创建、删除、扩容和缩容集群执行失败。

存储管理

存储管理接口,包括PersistentVolumeClaim、PersistentVolume的创建、删除。

插件管理

插件管理接口,包括AddonTemplates的查询,AddonInstance的创建、更新、删除和获取。

Kubernetes原生接口

Node

Node对象管理接口,包括Node对象的获取,查询和更新。

说明:

CCE仅支持使用集群管理中的接口创建、删除节点,不能使用Kubernetes原生接口来创建、删除节点。

Namespace

Namespace对象管理接口,包括Namespace对象的创建,查询,修改,删除等接口。

Resourcequotas

ResourceQuotas资源配额接口,包括查询接口。

Pod

Pod对象管理接口,包括Pod对象的创建,查询,修改,删除等接口。

Deployment

Deployment对象管理接口,包括Deployment对象的创建,查询,修改,删除等接口。

Statefulset

Statefulset对象管理接口,包括Statefulset对象的创建,查询,修改,删除等接口。

Daemonset

Daemonset对象管理接口,包括Daemonset对象的创建,查询,修改,删除等接口。

Job

Job对象管理接口,包括Job对象的创建,查询,修改,删除等接口。

CronJob

CronJob对象管理接口,包括CronJob对象的创建,查询,修改,删除等接口。

Replicset

Replicset对象的查询。

ReplicationController

ReplicationController对象管理接口,包括ReplicationController对象的创建,查询,修改,删除等接口。

Endpoints

Endpoint对象管理接口,包括Endpoint对象的创建,查询,修改,删除等接口。

Service

Service对象管理接口,包括Service对象的创建,查询,修改,删除等接口。

Ingress

Ingress对象管理接口,包括Ingress对象的创建,更新,删除等接口。

NetworkPolicy

NetworkPolicy对象管理接口,包括NetworkPolicy对象的创建,更新,删除等接口。

PersistentVolume

PersistentVolume对象管理接口,包括PersistentVolume对象的创建,查询,修改,删除等接口。

PersistentVolumeClaim

PersistentVolumeClaim对象管理接口,包括PersistentVolumeClaim对象的创建,查询,修改,删除等接口。

ConfigMap

ConfigMap对象管理接口,包括ConfigMap对象的创建,查询,修改,删除等接口。

Secret

Secret对象管理接口,包括Sercret对象的创建,查询,修改,删除等接口。

RBAC

通过权限设置可以让不同的用户或用户组拥有操作不同Kubernetes资源的权限。

API groups

API group对象管理接口,包括列出API group和APIVersion。

Event

Event对象管理的查询。

当前版本调用Kubernetes接口不支持HTTP长链接。

集群管理

表1 集群管理

API

说明

创建集群

创建一个空集群(即只有控制节点Master,没有工作节点Node)。

获取指定的集群

获取指定集群的详细信息。

获取指定项目下的集群

获取指定项目下所有集群的详细信息。

更新指定的集群

更新指定的集群。

删除集群

删除一个指定的集群。

集群休眠

休眠一个指定的集群。

集群唤醒

唤醒一个指定的已休眠集群。

获取集群证书

获取指定集群的证书信息。

创建节点

在指定集群下创建节点。

获取指定的节点

通过节点ID获取指定节点的详细信息。

获取集群下所有节点

通过集群ID获取指定集群下所有节点的详细信息。

更新指定的节点

更新指定的节点。

删除节点

删除指定的节点。

创建节点池

在指定集群下创建节点池。

获取指定的节点池

获取指定节点池的详细信息。

获取集群下所有节点池

获取集群下所有节点池。

更新指定节点池

更新指定的节点池。

删除节点池

删除指定的节点池。

获取任务信息

查询作业进度,通过某一作业请求下发后返回的jobID来查询指定作业的进度。

存储管理

表2 存储管理

API

说明

创建PVC

在指定的Namespace下通过华为云存储服务中的云存储(EVS、SFS、OBS)去创建PersistentVolumeClaim。

删除PVC

删除指定Namespace下的PersistentVolumeClaim对象,并可以选择保留后端的云存储。

创建PV(已废弃)

通过指定华为云存储服务中的云存储(如EVS、SFS、OBS)去创建PersistentVolume。

删除PV(已废弃)

删除指定Namespace下的PersistentVolume对象,并可以选择是否保留后端云存储。

插件管理

表3 插件管理

API

说明

创建AddonInstance

根据提供的插件模板,安装插件实例。

查询AddonTemplates列表

插件模板查询接口,查询插件信息。

更新AddonInstance

更新插件实例的功能。

删除AddonInstance

删除插件实例的功能。

获取AddonInstance详情

获取插件实例详情。

获取AddonInstance列表

获取集群所有已安装插件实例。

Node

表4 Node

API

说明

获取指定的Node

获取指定的Node。

列出指定的Node

获取指定的Node列表。

更新指定的Node

更新指定的Node。

Namespace

表5 Namespace

API

说明

创建Namespace

创建一个Namespace。

删除Namespace

删除一个Namespace。

获取指定的Namespace

获取指定的Namespace的详细信息。

替换指定的Namespace

替换指定的Namespace的部分信息。

替换指定的Namespace的状态

更新指定Namespace的状态信息,即修改namespace对象status各字段的值。

替换指定的Namespace的Finalize值

替换指定Namespce的finalize的值。

列出Namespace

获取集群中所有Namespace的详细信息。

更新指定的Namespace

更新指定Namespace部分信息。

Resourcequotas

表6 Resourcequotas

API

说明

获取Resourcequotas

列出或查询Resourcequotas的详细信息。

Pod

表7 Pod

API

说明

创建Pod

在指定Namespace下创建一个Pod对象。

删除Pod

删除指定Namespace下的某个Pod对象。

删除所有的Pod

删除所有Pod对象。

获取指定的Pod

获取指定Namespace下指定Pod的详细信息。

替换指定的Pod

替换指定Namespace下的一个Pod对象。

替换指定的Pod的状态

替换指定Namespace下的一个Pod对象的status,即修改Pod对象status各字段的值。

列出指定Namespaces下的所有Pod

列出指定Namespaces下面的所有Pod资源对象。

列出Pod

获取一个Pod列表。

更新指定的Pod

更新指定Namespace下一个Pod对象。

Deployment

表8 Deployment

API

说明

创建Deployment

创建一个Deployment资源对象。

创建Deployment的回滚操作

创建一个Deployment资源对象的回滚操作。

删除Deployment

删除一个Deployment资源对象。

删除所有的Deployment

删除所有的Deployment资源对象。

获取指定的Deployment

获取某个Namespace下指定的Deployment对象。

获取指定的Deployment的状态

获取某个Namespace下指定的Deployment对象的状态。

获取指定的Deployment的伸缩操作

获取指定的Deployment的伸缩操作。

替换指定的Deployment

替换指定的Deployment对象。

替换指定的Deployment的状态

替换指定命名空间下指定Deployment的状态,即修改Deployment的status字段的值。

替换指定的Deployment的伸缩操作

替换指定的Deployment的伸缩操作。

列出指定Namespace下的Deployment

列出指定命名空间下的所有Deployment资源对象。

列出指定的Deployment

列出指定的Deployment资源对象。

更新指定的Deployment

更新指定Namespace下的Deployment对象。

更新指定的Deployment的状态

更新指定Namespace下指定Deployment 对象的状态。

更新指定的Deployment的伸缩操作

更新指定的Deployment的伸缩操作。

StatefulSet

表9 StatefulSet

API

说明

创建StatefulSet

创建一个StatefulSet资源对象。

删除StatefulSet

删除一个StatefulSet资源对象。

删除所有的StatefulSet

删除所有的StatefulSet资源对象。

获取指定的StatefulSet

获取指定Namespace下的StatefulSet对象。

获取指定的StatefulSet的状态

获取指定Namespace下指定StatefulSet对象的状态。

替换指定的StatefulSet

替换指定Namespace下的StatefulSet对象。

替换指定的StatefulSet的状态

替换指定Namespace下指定StatefulSet对象的状态,即修改StatefulSet对象的status字段的值。

列出指定Namespace下的StatefulSet

列出指定Namespace下的所有StatefulSet资源对象。

列出指定的StatefulSet

列出所有的StatefulSet资源对象。

更新指定的StatefulSet

更新指定Namespace下的StatefulSet对象。

更新指定的StatefulSet的状态

更新指定Namespace下指定StatefulSet对象的状态。

DaemonSet

表10 DaemonSet

API

说明

创建DaemonSet

创建一个DaemonSet资源对象。

删除DaemonSet

删除一个DaemonSet资源对象。

删除所有的Daemonset

删除所有DaemonSet资源对象。

获取指定的DaemonSet

读取指定Namespace下的DaemonSet对象。

获取指定的DaemonSet的状态

读取指定Namespace下指定DaemonSet对象的状态。

更新指定的DaemonSet

更新指定Namespace下的DaemonSet对象。

更新指定的DaemonSet的状态

更新指定Namespace下指定DaemonSet对象的状态。

列出指定的DaemonSet

列出所有DemonSet资源对象。

列出指定Namespace下的DaemonSet

列出指定Namespace下的所有DaemonSet资源对象。

替换指定的DaemonSet

替换指定Namespace下的DaemonSet对象。

替换指定的DaemonSet的状态

替换指定Namespace下指定DaemonSet对象的状态,即修改DaemonSet对象的status字段的值。

Job

表11 Job

API

说明

创建Job

创建Job资源对象。

删除Job

删除Job资源对象。

删除所有的Job

删除所有的Job资源对象。

获取指定的Job

获取指定的Job资源对象。

获取指定的Job的状态

获取指定Job的状态信息。

替换指定的Job

替换指定Job。

替换指定的Job的状态

替换指定Job的状态。

列出指定Namespace下的Job

列出指定Namespace下的所有Jod资源对象。

列出所有Job

用于获取Job列表。

更新指定的Job的状态

更新指定Namespace下指定Job的状态。

更新指定的Job

更新指定的Job。

CronJob

表12 CronJob

API

说明

创建CronJob

创建CronJob资源对象。

删除CronJob

删除CronJob资源对象。

删除所有的CronJob

删除所有CronJob资源对象。

获取指定的CronJob

获取指定的CronJob资源对象。

获取指定的CronJob的状态

获取指定的CronJob的状态。

替换指定的CronJob

替换指定的CronJob资源对象。

替换指定的CronJob的状态

替换指定CronJob的状态。

列出指定Namespace下的CronJob

列出指定Namespace下的所有CronJod资源对象。

列出所有的CronJob

列出所有的CronJob资源对象。

更新指定的CronJob的状态

更新指定Namespace下指定CronJob的状态。

更新指定的CronJob

更新指定的CronJob资源对象。

ReplicSet

表13 ReplicSet

API

说明

列出指定的ReplicaSet

列出指定Namespace下的所有ReplicaSet资源对象。

ReplicationController

表14 ReplicationController

API

说明

创建ReplicationController

创建ReplicationController资源类型。

删除ReplicationController

删除一个ReplicationController对象。

删除所有的ReplicationController

批量删除ReplicationController。

获取指定Namespace下的ReplicationController

获取指定Namespace下的ReplicationController对象。

替换指定Namespace下的ReplicationController

替换指定Namespace下的ReplicationController对象。

替换指定Namespace下的ReplicationController状态

替换指定Namespace下的某个ReplicationController对象的状态,即修改ReplicationController对象status各字段的值。

列出指定Namespace下的ReplicationController

列出指定Namespace下的所有ReplicationController。

列出ReplicationController

获取ReplicationController列表。

更新指定的ReplicationController

更新指定Namespace下的ReplicationController对象。

Endpoints

表15 Endpoints

API

说明

创建Endpoints

创建一个Endpoints资源对象。

删除Endpoints

删除一个Endpoints资源对象。

删除所有的Endpoints

删除所有Endpoints资源对象。

获取指定的Endpoints

获取某个Namespace下指定的Endpoints对象。

替换指定的Endpoints

替换指定Namespace下指定的Endpoints资源对象。

列出Endpoints

列出所有的Endpoints资源对象。

列出指定Namespace下的Endpoints

获取指定Namespace下的所有Endpoints对象。

更新指定的Endpoints

更新指定Namespace下的Endpoints对象。

Service

表16 Service

API

说明

创建Service

创建一个Service对象。

删除Service

删除一个Service对象。

获取指定的Service

获取指定的Service对象。

替换指定的Service

替换指定的Service对象。

列出指定Namespace下的Service

列出指定Namespace下的Service对象。

列出Service

获取集群中的Service列表。

更新指定的Service

替换指定的Service对象。

Ingress

表17 Ingress

API

说明

创建Ingress

创建一个Ingress。

更新指定的Ingress

对指定的Ingress进行局部更新。

替换指定的Ingress

替换指定的Ingress。

删除Ingress

删除Ingress。

删除所有的Ingress

删除所有的Ingress。

获取指定的Ingress

获取指定的Ingress。

列出指定Namespace下的Ingress

列出指定Namespace下的Ingress。

获取Ingress列表

获取Ingress列表。

获取指定Namespace下的某个Ingress对象的状态

获取指定Namespace下的某个Ingress对象的状态。

替换指定Namespace下的某个Ingress对象的状态

替换指定Namespace下的某个Ingress对象的状态。

更新指定Namespace下的某个Ingress对象的状态

更新指定Namespace下的某个Ingress对象的状态。

NetworkPolicy

表18 NetworkPolicy

API

说明

创建networkpolicy

创建networkpolicy。

更新指定的networkpolicy

部分更新指定的NetworkPolicy。

替换指定的networkpolicy

替换指定的networkpolicy。

删除networkpolicy

删除networkpolicy。

批量删除networkpolicy

批量删除networkpolicy。

获取指定的networkpolicy

获取指定的networkpolicy。

列出指定namespace下的networkpolicy

列出指定namespace下的networkpolicy。

获取networkpolicy列表

获取networkpolicy列表。

PersistentVolume

表19 PersistentVolume

API

说明

创建PersistentVolume

创建一个PersistentVolume。

删除指定的PersistentVolume

删除指定的PersistentVolume对象。

删除所有的PersistentVolume

删除所有的PersistentVolume对象。

获取指定的PersistentVolume

获取指定的PersistentVolume对象。

替换指定的PersistentVolume

替换指定的PersistentVolume对象。

替换指定的PersistentVolume的状态

替换指定的PersistentVolume对象的状态。

列出所有的PersistentVolume

列出所有PersistentVolume资源对象。

更新指定的PersistentVolume

更新PersistentVolume对象。

PersistentVolumeClaim

表20 PersistentVolumeClaim

API

说明

创建PersistentVolumeClaim

在指定的Namespace下创建PersistentVolumeClaim。

删除指定的PersistentVolumeClaim

删除指定Namespace下的PersistentVolumeClaim对象。

删除所有的PersistentVolumeClaim

删除所有的PersistentVolumeClaim资源对象。

获取指定的PersistentVolumeClaim

获取指定Namespace下的PersistentVolumeClaim对象。

替换指定的PersistentVolumeClaim

替换指定Namespace下的PersistentVolumeClaim对象。

替换指定的PersistentVolumeClaim的状态

替换指定的Namespace下指定的PersistentVolumeClaim对象的状态。

列出指定的Namespace下的PersistentVolumeClaim

列出指定Namespace下的所有PersistentVolumeClaim资源对象。

列出所有的PersistentVolumeClaim

列出所有PersistentVolumeClaim资源对象。

更新指定的PersistentVolumeClaim

更新PersistentVolumeClaim对象。

ConfigMap

表21 ConfigMap

API

说明

创建ConfigMap

创建ConfigMap资源对象。

删除ConfigMap

删除ConfigMap资源对象。

删除所有的ConfigMap

删除所有ConfigMap资源对象。

获取指定的ConfigMap

获取指定的ConfigMap资源对象。

替换指定ConfigMap

替换指定的ConfigMap资源对象。

列出指定Namespace下的ConfigMap

列出指定Namespace下的所有ConfigMap资源对象。

列出指定的ConfigMap

获取ConfigMap列表。

更新指定的ConfigMap

更新指定的ConfigMap资源对象。

Secret

表22 Secret

API

说明

创建Secret

创建Secret资源类型。

删除Secret

删除指定Namespace下的Secret对象。

删除所有的Secret

批量删除Secret。

获取Secret信息

获取指定Secret的详细信息。

替换指定的Secret

替换指定Namespace下的Secret对象。

列出指定Namespace下的Secret

在指定的Namespace下列出Secret对象。

列出集群下的Secret

列出集群中的所有Secret对象。

RBAC

表23 RBAC

API

说明

创建ClusterRole

创建ClusterRole。

更新指定的ClusterRole

部分更新指定的ClusterRole。

替换指定的ClusterRole

替换指定的ClusterRole。

删除指定的ClusterRole

删除指定的ClusterRole。

批量删除ClusterRole

批量删除ClusterRole。

获取指定的ClusterRole

获取指定的ClusterRole。

获取ClusterRole列表

获取ClusterRole列表。

创建ClusterRoleBinding

创建ClusterRoleBinding。

更新指定的ClusterRoleBinding

部分更新指定的ClusterRoleBinding。

替换指定的ClusterRoleBinding

替换指定的ClusterRoleBinding。

删除指定的ClusterRoleBinding

删除指定的ClusterRoleBinding。

批量删除ClusterRoleBinding

批量删除ClusterRoleBinding。

获取指定的ClusterRoleBinding

获取指定的ClusterRoleBinding。

获取ClusterRoleBinding列表

获取ClusterRoleBinding列表。

创建Role

创建Role。

更新指定的Role

部分更新指定的Role。

替换指定的Role

替换指定的Role。

删除指定的Role

删除指定的Role。

批量删除Role

批量删除Role。

获取指定的Role

获取指定的Role。

获取指定namespace下的Role列表

列出指定namespace下的Role列表。

获取Role列表

获取Role列表。

创建RoleBinding

创建RoleBinding。

更新指定的RoleBinding

部分更新指定的RoleBinding。

替换指定的RoleBinding

替换指定的RoleBinding。

删除指定的RoleBinding

删除指定的RoleBinding。

批量删除RoleBinding

批量删除RoleBinding。

获取指定的RoleBinding

获取指定的RoleBinding。

获取指定namespace下RoleBinding列表

列出指定namespace下的RoleBinding列表。

获取RoleBinding列表

获取RoleBinding列表。

API groups

表24 API groups

API

说明

列出APIVersions

列出APIVersions。

列出APIGroups

列出 APIGroups。

listing APIResources of GroupVersion apiregistration.k8s.io/v1beta1

列出 APIGroups。

listing APIResources of GroupVersion extensions/v1beta1

列出 APIGroups。

listing APIResources of GroupVersion apps/v1beta1

列出APIResources of Group Version "apps/v1beta1"。

listing APIResources of GroupVersion authentication.k8s.io/v1

列出APIResources of GroupVersion "authentication.kubernetes.io/v1"

listing APIResources of GroupVersion authentication.k8s.io/v1beta1

列出APIResources of GroupVersion "authentication.k8s.io/v1beta1"。

listing APIResources of GroupVersion authorization.k8s.io/v1

列出APIResources of GroupVersion "authorization.k8s.io/v1"。

listing APIResources of GroupVersion authorization.k8s.io/v1beta1

列出APIResources of GroupVersion "authorization.k8s.io/v1beta1"。

listing APIResources of GroupVersion autoscaling/v1

列出APIResources of GroupVersion "autoscaling/v1"。

listing APIResources of GroupVersion batch/v1

列出APIResources of GroupVersion "batch/v1"。

listing APIResources of GroupVersion certificates.k8s.io/v1beta1

列出GroupVersion "certificates.k8s.io/v1beta1"。

listing APIResources of GroupVersion networking.k8s.io/v1

列出APIResources of GroupVersion "networking.k8s.io/v1"。

listing APIResources of GroupVersion policy/v1beta1

列出APIResources of GroupVersion "policy/v1beta1"。

listing APIResources of GroupVersion rbac.authorization.k8s.io/v1beta1

列出APIResources of GroupVersion "rbac.authorization.k8s.io/v1beta1"。

listing APIResources of GroupVersion storage.k8s.io/v1

列出APIResources of GroupVersion "storage.k8s.io/v1"。

listing APIResources of GroupVersion storage.k8s.io/v1beta1

列出APIResources of GroupVersion "storage.k8s.io/v1beta1"。

listing APIResources of GroupVersion apiextensions.k8s.io/v1beta1

列出APIResources of GroupVersion "apiextensions.k8s.io/v1beta1"。

listing APIResources of GroupVersion v1

列出APIResources of GroupVersion "v1"。

Event

表25 Event

API

说明

列出指定的Event

列出指定Namespace下的所有Event资源对象。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问