检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何获取接口URI中参数 项目ID(project_id) project_id即项目ID,可以通过控制台或API接口获取,具体请参见获取项目ID。 集群ID(cluster_id) 登录CCE控制台,在左侧导航栏中选择“集群管理”。 单击所创建集群的名称,进入集群详情页面,获取集群ID。
API概览 云容器引擎所提供的接口分为CCE接口与Kubernetes原生接口。通过配合使用CCE接口和Kubernetes原生接口,您可以完整的使用云容器引擎的所有功能,包括创建集群,使用Kubernetes接口创建容器工作负载,使用CCE接口监控工作负载的使用数据等。 类型 子类型
批量删除指定集群的资源标签 功能介绍 该API用于批量删除指定集群的资源标签。 此接口为幂等接口:删除时,如果删除的标签key不存在,默认处理成功。 调用方法 请参见如何调用API。 URI POST /autopilot/v3/projects/{project_id}/clu
批量添加指定集群的资源标签 功能介绍 该API用于批量添加指定集群的资源标签。 每个集群支持最多20个资源标签。 此接口为幂等接口:创建时,如果创建的标签已经存在(key/value均相同视为重复),默认处理成功;key相同,value不同时会覆盖原有标签。 调用方法 请参见如何调用API。 URI POST
错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 CCE.01400001 Invalid request. 请求体不合法。 请参考返回的message和CCE接口文档修改请求体,或联系技术支持。
UpgradeClusterRequestMetadata 参数 是否必选 参数类型 描述 apiVersion 是 String 参数解释: API版本 约束限制: 固定值 取值范围: v3 kind 是 String 参数解释: API类型 约束限制: 固定值 取值范围: UpgradeTask 表4
完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-tok
集群升级涉及多维度的组件升级操作,强烈建议统一通过CCE控制台执行交互式升级,降低集群升级过程的业务意外受损风险; 当前集群升级相关接口受限开放。 调用方法 请参见如何调用API。 URI POST /autopilot/v3/projects/{project_id}/clusters/{cl
获取项目ID 操作场景 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。有如下两种获取方式: 调用API获取项目ID 从控制台获取项目ID 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https:
netes API: 通过集群API Server调用Kubernetes API:(推荐)直接连接集群API Server,适合大规模调用。 通过API网关调用Kubernetes API:适合小规模调用场景,大规模调用时可能会触发API网关流控。 通过集群API Server调用Kubernetes
通过控制台可视化生成API参数 在使用API创建集群或节点时,如果请求中的API参数组合不正确,将会导致接口调用失败。您可以通过控制台可视化生成API参数,根据选项配置自动生成正确的参数组合。 生成创建集群的API参数 登录CCE控制台。 在“集群管理”页面右上角单击“购买集群”。
请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 apiVersion 是 String 参数解释: API版本 约束限制: 固定值 取值范围: v3 kind 是 String 参数解释: API类型 约束限制: 固定值 取值范围: PostCheckTask spec
创建集群 功能介绍 该API用于创建一个空集群(即只有控制节点Master,没有工作节点Node)。 集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径。 接口约束 调用CCE接口创建集群之前,请检查是否已满足如下条件:
某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scop
响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 kind String API类型,固定值“Addon”,该值不可修改。 apiVersion String API版本,固定值“v3”,该值不可修改。 items Array of AddonTemplate
的数据存储能力,可供用户存储任意类型和大小的数据。适合企业备份/归档、视频点播、视频监控等多种数据存储场景。 标准接口:具备标准Http Restful API接口,用户必须通过编程或第三方工具访问对象存储。 数据共享:服务器、嵌入式设备、IOT设备等所有调用相同路径,均可访问共享的对象存储数据。
获取集群证书 功能介绍 该API用于获取指定集群的证书信息。 接口约束 该接口适用于1.13及以上集群版本。 调用方法 请参见如何调用API。 URI POST /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/clustercert
获取任务信息 功能介绍 该API用于获取任务信息。通过某一任务请求下发后返回的jobID来查询指定任务的进度。 集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径 该接口通常使用场景为: 创建、删除集群时,查询相应任务的进度。
开启集群升级流程引导任务 功能介绍 该API用于创建一个集群升级流程引导任务。请在调用本接口完成引导任务创建之后,通过集群升级前检查开始检查任务。 升级流程任务用于控制集群升级任务的执行流程,执行流程为 升级前检查 => 集群升级 => 升级后检查。 调用方法 请参见如何调用API。 URI POST
获取集群升级任务详情,任务ID由调用集群升级API后从响应体中uid字段获取。 集群升级涉及多维度的组件升级操作,强烈建议统一通过CCE控制台执行交互式升级,降低集群升级过程的业务意外受损风险; 当前集群升级相关接口受限开放。 调用方法 请参见如何调用API。 URI GET /autopi