如何调用API 构造请求 认证鉴权 返回结果
了解详细的Karmada API信息请参见Karmada API。 UCS支持通过API网关调用Karmada API。
API UCS集群 容器舰队 权限管理
获取集群接入信息 功能介绍 该API接口用于获取集群接入信息;传入的cluster ID必须符合k8s UUID的格式规则;同时需要用户有对应集群证书的获取权限,否则会鉴权失败;agent证书只可以下载一次。
对于获取用户Token接口,返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 父主题: 如何调用API
Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择domain,如下所示。
apiVersion String API版本,固定值“v1”,该值不可修改。 spec JobSpec object spec是集合类的元素类型,您对需要管理的对象进行详细描述的主体部分都在spec中给出。UCS通过spec的描述来创建或更新对象。
注册集群 功能介绍 集群注册接口。支持三方集群的注册和CCE导入集群的注册。
apiVersion 是 String API版本,固定值“v1”,该值不可修改。 metadata 否 ObjectMeta object 集群的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性。
删除集群 功能介绍 用于集群解除注册;传入的cluster ID必须符合k8s UUID的格式规则;同时需要用户有对应集群的操作权限,否则会鉴权失败。 URI DELETE /v1/clusters/{clusterid} 表1 路径参数 参数 是否必选 参数类型 描述 clusterid
UCS集群 获取集群列表 获取单个集群 注册集群 更新集群 删除集群 获取集群接入信息 激活集群 集群关联权限策略 获取租户的CCE集群列表 查询支持接入UCS的集群版本列表 父主题: API
权限管理 创建权限策略 获取权限策略列表 删除权限策略 更新权限策略 父主题: API
apiVersion String API版本,固定值“v1”,该值不可修改。 metadata ObjectMeta object 集群的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性。
激活集群 功能介绍 激活集群接口;传入的cluster ID必须符合k8s UUID的格式规则;同时需要用户有对应集群的更新权限,否则会鉴权失败 URI PUT /v1/clusters/{clusterid}/activation 表1 路径参数 参数 是否必选 参数类型 描述
对于管理员创建IAM用户接口,返回如图1所示的消息头,其中“X-Subject-Token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 建议在配置文件或者环境变量中密文存放,使用时解密,确保安全。
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。
删除容器舰队 功能介绍 容器舰队删除接口,只有在容器舰队为空时才可以删除该容器舰队,若需删除请先将集群移出容器舰队;传入的cluster ID必须符合k8s UUID的格式规则;同时需要用户有对应集群的操作权限,否则会鉴权失败 URI DELETE /v1/clustergroups
注册容器舰队 功能介绍 容器舰队创建API,生成容器舰队时可以选择关联的集群 URI POST /v1/clustergroups 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 身份认证信息 最小长度:1 最大长度
向容器舰队中添加集群 更新容器舰队描述信息 更新容器舰队关联权限策略 更新容器舰队的联邦对应的zone 获取容器舰队列表 启用容器舰队联邦 关闭容器集群联邦 查询联邦开启进度 创建联邦网络连接并下载联邦kubeconfig 创建联邦网络连接 下载联邦kubeconfig 父主题: API
apiVersion String API版本,固定值“v1”,该值不可修改。 metadata ObjectMeta object 舰队的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性。
您即将访问非华为云网站,请注意账号财产安全