API概览_云容器实例 CCI_API参考

VIEW CONTENTS

摘要: 云容器实例所提供的接口为CCI接口和Kubernetes原生接口。通过使用云容器实例提供的接口，您可以完整的使用云容器实例的所有功能，包括创建无状态负载、有状态负载等。 ...

点击领取2000元阿里云代金券，付款抵现金用，云服务器69元/年限时抢>>>    点击咨询成为阿里云VIP客户享永久折扣>>>
点击领取2860元腾讯云代金券，付款抵现金用，云服务器88元/年限时抢>>>    点击成为腾讯云VIP客户享永久折扣优惠>>>
点击进入华为云最新优惠活动现场>>>    点击成为华为云VIP客户享永久折扣优惠>>>

云容器实例所提供的接口为CCI接口和Kubernetes原生接口。通过使用云容器实例提供的接口，您可以完整的使用云容器实例的所有功能，包括创建无状态负载、有状态负载等。

大类	类型	说明
API	Network	Network对象管理接口，包括Network对象的创建、查询、修改、删除等接口。 Network对象是华为云CCI新增对象，用于定义kubernetes中一个namespace内的网络与华为云虚拟私有云服务的子网和VPC的映射关系。
API	Extended PersistentVolumeClaim	Extended PersistentVolumeClaim对象管理接口，包括导入存储、查询导入的PVC、解绑存储接口。
Kubernetes API	Namespace	Namespace对象管理接口，包括Namespace对象的创建、查询、修改、删除等接口。命名空间（namespace）是一种在多个用户之间划分资源的方法。当你的项目和人员众多的时候可以考虑根据项目属性，例如生产、测试、开发划分不同的namespace。
	Pod	Pod对象管理接口，包括Pod对象的查询接口。 Pod是Kubernetes创建或部署的最小单位。一个Pod封装一个或多个容器、存储资源、一个独立的网络IP以及管理控制容器运行方式的策略选项。
	Deployment	Deployment对象管理接口，包括Deployment对象的创建、查询、修改、删除等接口。 Deployment是Pod Controller的一种。一个Deployment可以包含一个或多个Pod副本，每个Pod副本的角色相同，所以系统会自动为Deployment的多个Pod副本分发请求。Deployment中的所有Pod副本共享存储卷。
	StatefulSet	Statefulset对象管理接口，包括Statefulset对象的创建、查询、修改、删除等接口。 StatefulSet同样是Pod的Controller的一种。一个StatefulSet可以包含一个或多个Pod副本，不同的Pod副本的角色有区别，且每个Pod副本都有独立的访问域名，所以用户可以手动指定请求在Pod副本之间的分发路径。StatefulSet的Pod副本间不共享数据，因此每个Pod副本都会被分配独立的专属存储卷。
	Job	Job对象管理接口，包括Job对象的创建、查询、修改、删除等接口。 Job是用来控制批处理型任务的资源对象。批处理业务与长期伺服业务（Deployment、Statefulset）的主要区别是批处理业务的运行有头有尾，而长期伺服业务在用户不停止的情况下永远运行。Job管理的Pod根据用户的设置把任务成功完成就自动退出了。
	Service	Service对象管理接口，包括Service对象的创建、查询、修改、删除等接口。 Service定义了这样一种抽象：一个Pod的逻辑分组，一种可以访问它们的策略（通常称为微服务）。
	Ingress	Ingress对象管理接口，包括Ingress对象的创建、查询、修改、删除等接口。 Ingress是授权入站连接到达集群服务的规则集合。您可以给Ingress配置外部可访问的URL、负载均衡、SSL、基于名称的虚拟主机等。
	ConfigMap	Configmap对象管理接口，包括Configmap对象的创建、查询、修改、删除等接口。
	Secret	Secret对象管理接口，包括Secret对象的创建、查询、修改、删除等接口。
	PersistentVolumeClaim	PersistentVolumeClaim对象管理接口，包括PersistentVolumeClaim对象的创建、查询、修改、删除等接口。 PersistentVolumeClaim（PVC）是用户存储的请求。它类似于Pod，Pod申请CPU和内存，PVC申请存储资源。
	Event	Event对象管理接口，包括Event对象的查询接口。
	API Groups	API GroupS查询接口，可以查询各个Group下的API资源。
	Endpoint	Endpoint对象管理接口，包括Endpoint对象的查询接口。
	ReplicaSet	ReplicaSet对象管理接口，包括ReplicaSet对象的查询接口。
	VolcanoJob	VolcanoJob对象管理接口，包括VolcanoJob对象的创建、查询、修改、删除接口。
	TFJob	TFJob即Tensorflow任务，是基于Tensorflow开源框架的kubernetes自定义资源类型，有多种角色可以配置，能够帮助我们更简单地实现Tensorflow的单机或分布式训练。
	MXJob	MXJob即MXNet任务，是基于MXNet开源框架的kubernetes自定义资源类型，有多种角色可以配置，能够帮助我们更简单地实现MXNet的训练。
	PyTorchJob	PyTorchJob即PyTorch任务，是基于PyTorch开源框架的kubernetes自定义资源类型，有多种角色可以配置，能够帮助我们更简单地实现PyTorch的训练。
	RBAC	通过权限设置可以让不同的用户或用户组拥有操作不同Kubernetes资源的权限。

Network

API	说明
创建Network	创建一个Network对象。 Network对象是华为云CCI 新增对象，用于定义kubernetes中一个namespace内的网络与华为云虚拟私有云服务的子网和VPC的映射关系。
查询Network	查询Network信息。
查询所有Network	查询指定namespace下的所有Network对象。
查询Network状态	查询一个指定Network对象的状态。
删除Network	删除一个指定Network对象。
删除所有Network	删除指定namespace下的所有Network对象。

Extended PersistentVolumeClaim

API	说明
导入存储	导入已有存储到指定的命名空间。
查询导入的PVC	查询指定命名空间下的PVC。
解绑存储	从指定命名空间解绑存储的接口。该接口扩展了原生的删除存储接口，增加了是否删除volume和存储类型的参数。

Namespace

API	说明
创建Namespace	创建一个Namespace。
查询Namespace	查询Namespace的详细信息。
列出Namespace	列出用户所有Namespace。
删除Namespace	删除一个Namespace。

Pod

API	说明
创建Pod	创建一个Pod。
查询Pod	查询Pod的详细信息。
查询指定Namespace下所有Pod	查询所有Pod的详细信息。
查询Pod状态	查询Pod对象的状态。
查询Pod日志	查询Pod的日志。
列出用户所有的Pod	列出用户所有的Pod。
替换Pod	替换指定Pod。
更新Pod	更新Pod。
删除Pod	删除Pod。
删除所有Pod	删除Namespace下所有Pod。

Deployment

API	说明
创建Deployment	创建一个Deployment。
查询Deployment	查询Deployment的详细信息。
查询Namespace下所有Deployment	查询Namespace下所有Deployment的详细信息。
查询Deployment状态	查询Deployment的状态。
查询Deployment的伸缩操作	查询Deployment伸缩操作。
列出用户所有Deployment	列出用户所有的Deployment。
替换Deployment	替换Deployment。
替换Deployment的伸缩操作	替换Deployment伸缩操作。
更新Deployment	更新Deployment。
更新Deployment的伸缩操作	更新Deployment伸缩操作。
删除Deployment	删除Deployment。
删除所有Deployment	删除Namespace下所有Deployment。

StatefulSet

API	说明
创建StatefulSet	创建StatefulSet。
查询StatefulSet	查询StatefulSet的详细信息。
查询指定namespace下所有StatefulSet	查询Namespace下所有StatefulSet的详细信息。
查询StatefulSet状态	查询StatefulSet状态。
列出用户所有的StatefulSet	列出用户所有的Statefulset。
替换StatefulSet	替换StatefulSet。
更新StatefulSet	更新StatefulSet。
删除StatefulSet	删除StatefulSet。
删除所有StatefulSet	删除Namespace下所有StatefulSet。

Job

API	说明
创建Job	创建Job。
查询Job	查询Job的详细信息。
查询指定namespace下所有Job	查询Namespace下所有Job的详细信息。
查询Job状态	查询Job状态。
列出用户所有Job	列出用户所有Job。
替换Job	替换Job。
更新Job	更新Job。
删除Job	删除Job。
删除所有Job	删除Namespace下所有Job。

Service

API	说明
创建Service	创建一个Service。
查询Service	查询Service的详细信息。
查询所有Service	查询Namespace下所有Service的详细信息。
查询service状态	查询指定的Service的状态。
删除Service	删除Service。

Ingress

API	说明
创建Ingress	创建Ingress。
查询Ingress	查询Ingress的详细信息。
查询所有Ingress	查询Namespace下所有Ingress的详细信息。
查询Ingress状态	查询Ingress状态。
替换Ingress	替换Ingress。
更新Ingress	更新Ingress。
删除Ingress	删除Ingress。
删除所有ingress	删除Namespace下所有Ingress。

ConfigMap

API	说明
创建ConfigMap	创建ConfigMap。
查询ConfigMap	查询ConfigMap详细信息。
查询所有ConfigMap	查询Namespace下所有ConfigMap的详细信息。
替换ConfigMap	替换ConfigMap。
更新ConfigMap	更新ConfigMap。
删除ConfigMap	删除ConfigMap。
删除所有ConfigMap	删除Namespace下所有ConfigMap。

Secret

API	说明
创建Secret	创建Secret。
替换Secret	替换Secret。
更新Secret	更新Secret中部分信息。
删除Secret	删除Secret。
删除所有Secret	删除Namespace下所有Secret。

PersistentVolumeClaim

API	说明
创建PersistentVolumeClaim	创建PersistentVolumeClaim。
查询PersistentVolumeClaim	查询PersistentVolumeClaim。
查询所有PersistentVolumeClaim	查询Namespace下的所有PersistentVolumeClaim。
删除PersistentVolumeClaim	删除PersistentVolumeClaim。

Event

API	说明
查询Event	查询Event详细信息。
查询所有Event	查询Namespace下所有Event的详细信息。
删除Event	删除Event。

API Groups

API	说明
列出APIVersions	列出所有API Version。
列出APIGroups	列出所有API Group。
列出所有extensions/v1beta1版本的API	列出所有extensions/v1beata1版本的API。
列出所有apps/v1版本的API	列出所有apps/v1版本的API。
列出所有apps/v1beta1版本的API	列出所有apps/v1beata1版本的API。
列出所有batch/v1版本的API	列出所有batch/v1版本的API。
列出所有networking.cci.io/v1beta1版本的API	列出所有networwking.cci.io/v1beata1版本的API。
列出所有v1版本的API	列出所有v1版本的API。

Endpoint

API	说明
查询Endpoint	查询Endpoint。
查询所有Endpoints	查询所有Endpoints。

ReplicaSet

API	说明
查询所有ReplicaSets	查询所有ReplicaSets。

VolcanoJob

API	说明
获取namespace下的所有Volcano Job	查询命名空间下所有的Volcano Job。
创建Volcano Job	创建Volcano Job。
删除namespace下的所有Volcano Job	删除命名空间下的所有Volcano Job。
查询Volcano Job详情	查询Volcano Job的详细信息。
替换Volcano Job	替换Volcano Job。
删除Volcano Job	删除Volcano Job。
更新Volcano Job	更新Volcano Job。

TFJob

API	说明
创建TFJob	创建TFJob。
查询TFJob	查询TFJob的详细信息。
查询指定namespace下的所有TFJob	查询Namespace下所有TFJob的详细信息。
删除namespace下的所有TFJob	删除命名空间下的所有TFJob。
删除TFJob	删除TFJob。
更新TFJob	更新TFJob。
替换TFJob	替换TFJob。

MXJob

API	说明
创建MXJob	创建MXJob。
查询MXJob	查询MXJob的详细信息。
查询指定namespace下的所有MXJob	查询Namespace下所有MXJob的详细信息。
删除namespace下的所有MXJob	删除命名空间下的所有MXJob。
删除MXJob	删除MXJob。
更新MXJob	更新MXJob。
替换MXJob	替换MXJob。

PyTorchJob

API	说明
创建PyTorchJob	创建PyTorchJob。
查询PyTorchJob	查询PyTorchJob的详细信息。
查询指定namespace下的所有PyTorchJob	查询Namespace下所有PyTorchJob的详细信息。
删除namespace下的所有PyTorchJob	删除命名空间下的所有PyTorchJob。
删除PyTorchJob	删除PyTorchJob。
更新PyTorchJob	更新PyTorchJob。
替换PyTorchJob	替换PyTorchJob。

RBAC

表1 RBAC
API	说明
获取指定的ClusterRole	获取指定的ClusterRole。
获取ClusterRole列表	获取ClusterRole列表。
创建RoleBinding	创建RoleBinding。
更新指定的RoleBinding	部分更新指定的RoleBinding。
替换指定的RoleBinding	替换指定的RoleBinding。
删除指定的RoleBinding	删除指定的RoleBinding。
获取指定的RoleBinding	获取指定的RoleBinding。
获取指定namespace下RoleBinding列表	列出指定namespace下的RoleBinding列表。
获取RoleBinding列表	获取RoleBinding列表。