检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
注册容器舰队 功能介绍 容器舰队创建API,生成容器舰队时可以选择关联的集群 URI POST /v1/clustergroups 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 身份认证信息 最小长度:1 最大长度:16384
ObjectMeta object 集群的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性。 spec ClusterSpec object spec是集合类的元素类型,您对需要管理的集群对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。 status
权限管理 创建权限策略 获取权限策略列表 删除权限策略 更新权限策略 父主题: API
ObjectMeta object 舰队的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性。 spec ClusterGroupSpec object spec是集合类的元素类型,您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。 status
获取集群接入信息 功能介绍 该API接口用于获取集群接入信息;传入的cluster ID必须符合k8s UUID的格式规则;同时需要用户有对应集群证书的获取权限,否则会鉴权失败;agent证书只可以下载一次。仅用于获取三方集群的集群接入信息,CCE集群不从该接口获取,如果传入CCE集群ID,返回码为400
Rule objects 权限策略列表 total Integer 所有页的结果的总数 表4 Rule 参数 参数类型 描述 kind String API类型。 apiVersion String API版本,固定值“v1”,该值不可修改。 metadata ObjectMeta
spec是集合类的元素类型,您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。 表4 RuleSpec 参数 是否必选 参数类型 描述 iamuserids 否 Array of strings 权限策略关联的IAM用户信息 type
创建联邦网络连接并下载联邦kubeconfig 功能介绍 舰队开通联邦后,调用此接口,创建vpcep终端节点,连接到联邦apiserver,并下载联邦apiserver的kubeconfig URI POST /v1/clustergroups/{clustergroupid}/cert
CreateRuleObjectMeta object 基本信息,为集合类的元素类型,包含一组由不同名称定义的属性。 spec 是 RuleSpec object spec是集合类的元素类型,您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。 表3 CreateRuleObjectMeta
激活集群 功能介绍 激活集群接口;传入的cluster ID必须符合k8s UUID的格式规则;同时需要用户有对应集群的更新权限,否则会鉴权失败 URI PUT /v1/clusters/{clusterid}/activation 表1 路径参数 参数 是否必选 参数类型 描述
删除集群 功能介绍 用于集群解除注册;传入的cluster ID必须符合k8s UUID的格式规则;同时需要用户有对应集群的操作权限,否则会鉴权失败。 URI DELETE /v1/clusters/{clusterid} 表1 路径参数 参数 是否必选 参数类型 描述 clusterid
删除权限策略 功能介绍 删除权限策略 URI DELETE /v1/permissions/rules/{ruleid} 表1 路径参数 参数 是否必选 参数类型 描述 ruleid 是 String 权限策略id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述
启用容器舰队联邦 功能介绍 启用容器舰队联邦 URI POST /v1/clustergroups/{clustergroupid}/federations 表1 路径参数 参数 是否必选 参数类型 描述 clustergroupid 是 String 容器舰队id 表2 Query参数
身份认证信息 表3 请求Body参数 参数 是否必选 参数类型 描述 clusterGroupID 否 String 集群加入目标容器舰队的id 响应参数 无 请求示例 集群加入容器舰队 POST https://ucs.myhuaweicloud.com/v1/clusters/{clusterid}/join
删除容器舰队 功能介绍 容器舰队删除接口,只有在容器舰队为空时才可以删除该容器舰队,若需删除请先将集群移出容器舰队;传入的cluster ID必须符合k8s UUID的格式规则;同时需要用户有对应集群的操作权限,否则会鉴权失败 URI DELETE /v1/clustergroups/{clustergroupid}
objects 权限策略id以及涉及到的命名空间 表4 RuleIDNamespaces 参数 是否必选 参数类型 描述 ruleIDs 否 Array of strings 权限策略id namespaces 否 Array of strings 权限策略涉及到的命名空间 响应参数 无 请求示例
关闭容器集群联邦 功能介绍 关闭容器舰队联邦 URI DELETE /v1/clustergroups/{clustergroupid}/federations 表1 路径参数 参数 是否必选 参数类型 描述 clustergroupid 是 String 容器舰队id 请求参数
集群移出容器舰队 功能介绍 集群退出容器舰队 URI POST /v1/clusters/{clusterid}/unjoin 表1 路径参数 参数 是否必选 参数类型 描述 clusterid 是 String 集群id 请求参数 表2 请求Header参数 参数 是否必选 参数类型
更新容器舰队描述信息 功能介绍 更新集群所属的容器舰队description信息;需要用户对相应容器舰队有更新权限 URI PUT /v1/clustergroups/{clustergroupid}/description 表1 路径参数 参数 是否必选 参数类型 描述 clustergroupid
向容器舰队中添加集群 功能介绍 向容器舰队中添加集群,同批次可以添加一个或多个集群,该接口无法清空或减少管理的集群。 URI PUT /v1/clustergroups/{clustergroupid}/associatedclusters 表1 路径参数 参数 是否必选 参数类型