注册容器舰队 - RegisterClusterGroup_容器舰队_API_API参考

功能介绍

容器舰队创建API，生成容器舰队时可以选择关联的集群

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/clustergroups

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	身份认证信息，调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值
Content-Type	是	String	消息体的类型（格式），仅支持application/json

表2 请求Body参数
参数	是否必选	参数类型	描述
metadata	是	RegisterClusterGroupObjectMeta object	容器舰队元数据信息。
spec	否	RegisterClusterGroupSpec object	属性

表3 RegisterClusterGroupObjectMeta
参数	是否必选	参数类型	描述
name	是	String	容器舰队名称

表4 RegisterClusterGroupSpec
参数	是否必选	参数类型	描述
clusterIds	否	Array of strings	关联的集群id
description	否	String	容器舰队描述信息

响应参数

状态码：201

表5 响应Body参数
参数	参数类型	描述
uid	String	容器舰队的UID信息

状态码：400

表6 响应Body参数
参数	参数类型	描述
-	String	-

状态码：403

表7 响应Body参数
参数	参数类型	描述
-	String	-

状态码：500

表8 响应Body参数
参数	参数类型	描述
-	String	-

请求示例

创建舰队，同时（可选）将集群加入该舰队

https://ucs.myhuaweicloud.com/v1/clustergroups

{
  "metadata" : {
    "name" : "group02281605"
  },
  "spec" : {
    "clusterIds" : [ "514c1a3c-8ec7-11ec-b384-0255ac100189", "d4804da3-8f03-11ec-b384-0255ac100189" ],
    "description" : "aaaaaaaaa"
  }
}

响应示例

状态码：201

返回创建成功的容器舰队UID信息

{
  "uid" : "6efb4a18-2fa4-11ee-ad1d-0255ac1001c4"
}

状态码

状态码	描述
201	返回创建成功的容器舰队UID信息
400	客户端请求错误，服务器无法执行请求
403	服务器拒绝执行请求
500	服务器内部错误

错误码

请参见错误码。

注册容器舰队 - RegisterClusterGroup