更新时间:2023-12-22 GMT+08:00
分享

注册集群

功能介绍

集群注册接口。支持三方集群的注册和CCE导入集群的注册。

URI

POST /v1/clusters

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

身份认证信息

最小长度:1

最大长度:16384

表2 请求Body参数

参数

是否必选

参数类型

描述

kind

String

资源类型。注册集群必须填写为Cluster。

apiVersion

String

API版本信息。现版本仅为v1。

metadata

metadata object

集群元数据信息。

spec

spec object

集群spec信息。

表3 metadata

参数

是否必选

参数类型

描述

UID

String

集群ID信息,仅在注册CCE导入集群时使用,其他类型集群无需填写。

name

String

CCE集群填写CCE集群名称,其他类型集群自定义

labels

Map<String,String>

标签信息。可为空,不为空时,必须满足kurbenetes label规范。

annotations

Map<String,String>

集群annotations信息。 附着集群必填一个kubeconfig字段,取值是kubeconfig文件的内容。kubeconfig文件获取方法请参见获取KubeConfig文件

表4 spec

参数

是否必选

参数类型

描述

clusterGroupID

String

容器舰队ID信息。

category

String

集群类别,填写需要与provider和type对应,具体请参见集群类别与类型说明

type

String

集群类型,填写需要与category和provider对应,具体请参见集群类别与类型说明

provider

String

供应商,填写需要与category和type对应,具体请参见集群类别与类型说明

country

String

所在国家代码,具体代码请参见国家码

city

String

所在城市代码,具体代码请参见城市码。仅支持中国城市,其他国家无需填写。

region

String

地域信息。仅在CCE导入集群注册时使用。可通过获取未注册到UCS的CCE集群接口的region字段获取。

projectID

String

项目ID信息。仅在CCE导入集群注册时使用。可通过获取未注册到UCS的CCE集群接口的projectID字段获取。

manageType

String

集群管理类型信息。 取值如下:

  • grouped:在舰队中纳管的集群

  • discrete:未加入舰队的集群

network

NetworkConfig object

多云集群的网络配置,其他类型集群不涉及

表5 NetworkConfig

参数

是否必选

参数类型

描述

podCIDR

String

容器网段

serviceCIDR

String

服务网段

响应参数

状态码: 201

表6 响应Body参数

参数

参数类型

描述

uid

String

集群ID

请求示例

  • 注册华为云CCE集群

    POST https://ucs.myhuaweicloud.com/v1/clusters
    
    {
      "metadata" : {
        "uid" : "44052cdd-8cd2-11ee-abd1-0255ac1001bd"
      },
      "spec" : {
        "region" : "cn-north-7",
        "category" : "self",
        "type" : "turbo",
        "projectID" : "05495693df80d3c92fa1c01795c2be02",
        "clusterGroupID" : "",
        "manageType" : "discrete"
      }
    }
  • 注册附着集群

    POST https://ucs.myhuaweicloud.com/v1/clusters
    
    {
      "kind" : "Cluster",
      "apiVersion" : "v1",
      "metadata" : {
        "name" : "ack-cluster",
        "annotations" : {
          "kubeconfig" : "{\"kind\":\"Config\",\"apiVersion\":\"v1\",\"preferences\":{},\"clusters\":[{\"name\":\"internalCluster\",\"cluster\":{\"server\":\"https://kubernetes.default.svc.cluster.local:443\",\"insecure-skip-tls-verify\":true}}],\"users\":[{\"name\":\"ucs-user\",\"user\":{\"token\":\"eyJhbGciOiJSUzI1NiIsImtpZCI6Ik9IT0RDSVhaa3BmQTNVWUNyRVFIYktQZGVtcFJISjNsZUctbjdsT1Z3ZzAifQ.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJkZWZhdWx0Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZWNyZXQubmFtZSI6InVjcy11c2VyLXRva2VuIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQubmFtZSI6InVjcy11c2VyIiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9zZXJ2aWNlLWFjY291bnQudWlkIjoiY2QzMmRmODEtY2NlOC00MTRlLWFjMTUtNzE5ZThmOWU0MjJjIiwic3ViIjoic3lzdGVtOnNlcnZpY2VhY2NvdW50OmRlZmF1bHQ6dWNzLXVzZXIifQ.n7m_9THJMrNQzNMh06RBLJpf328a227ZFnNFwNJ26E-SUnIzovtZ2BFQsFIpewXsHZ1OrW5dTcYfaCp50vplmplWdWWPYdgMoSGBu7IIauPmd2lQisDRXoqvYrL8v-xSSf3fbEnaPZH9T0KKk7pilfVyW8sDQME5K-JqzFTgo7mEUeEOK7mAnp9ZsdJegYUWYgrltbL78eglKDUOdV4CI7CbA47-E13UW5kLaIxDmDxI-s3jzXwt47372CXbwqjThZ6QiG_YJu8YtGL-lySIwAuqGXCzJVldWONffQRp7XWjdcC3V5yWX9737DieH5TN8dor1dLQMTAMCUfIAU6T3Q\"}}],\"contexts\":[{\"name\":\"internal\",\"context\":{\"cluster\":\"internalCluster\",\"user\":\"ucs-user\"}}],\"current-context\":\"internal\"}"
        },
        "labels" : { }
      },
      "spec" : {
        "category" : "attachedcluster",
        "clusterGroupID" : "",
        "manageType" : "discrete",
        "city" : "110000",
        "country" : "CN",
        "CLUSTER_PROVIDER" : {
          "ALI" : "aliyun",
          "TENCENT" : "tencentcloud",
          "AWS" : "aws",
          "GOOGLE" : "googlecloud",
          "AZURE" : "azure",
          "OPENSHIFT" : "openshift",
          "HUAWEISTACK" : "huaweicloudstack",
          "HUAWEI" : "huaweicloud",
          "PRIVATEK8S" : "privatek8s",
          "OTHER" : "other",
          "FLEXIBLEENGINE" : "FlexibleEngine",
          "FLEXIBLEENGINESTACK" : "FlexibleEngineStack",
          "OPENTELEKOMCLOUD" : "OpenTelekomCloud",
          "OPENTELEKOMCLOUDSTACK" : "OpenTelekomCloudStack",
          "TIANYI" : "ctcloud",
          "MOBILE" : "cmcloud"
        },
        "type" : "ack"
      }
    }

响应示例

状态码: 201

注册集群成功的返回信息,返回注册集群的Cluster ID

{
  "uid" : "b0d1ecb5-7947-11ee-9467-0255ac1001bf"
}

状态码

状态码

描述

201

注册集群成功的返回信息,返回注册集群的Cluster ID

400

客户端请求错误,服务器无法执行请求

403

服务器拒绝执行请求

404

资源不存在

409

请求存在冲突

500

服务器内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品