文档首页> 云容器引擎 CCE> API参考 (巴黎区域) > API> 集群管理> 绑定、解绑集群公网apiserver地址
更新时间：2023-07-03 GMT+08:00
查看PDF

绑定、解绑集群公网apiserver地址

功能介绍

该API用于通过集群ID绑定、解绑集群公网apiserver地址

集群管理的URL格式为：https://Endpoint/uri。其中uri为资源路径，也即API访问的路径。

URI

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/mastereip

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见如何获取接口URI中参数。

cluster_id

是

String

集群ID，获取方式请参见如何获取接口URI中参数。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式）

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。
表3 请求Body参数

参数

是否必选

参数类型

描述

spec

是

MasterEIPRequestSpec object

绑定、解绑集群公网apiserver地址的请求配置参数
表4 MasterEIPRequestSpec

参数

是否必选

参数类型

描述

action

否

String

绑定或解绑动作，必选参数。

  • 绑定：固定值为{"action":"bind"}

  • 解绑：固定值为{"action":"unbind"}

spec

否

spec object

待绑定的弹性IP配置属性

bandwidth

否

String

带宽(字段已失效，暂不推荐使用)

elasticIp

否

String

弹性网卡IP(字段已失效，暂不推荐使用)
表5 spec

参数

是否必选

参数类型

描述

id

否

String

弹性网卡ID，绑定时必选，解绑时该字段无效

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

metadata

Metadata object

基本信息，为集合类的元素类型，包含一组由不同名称定义的属性

spec

MasterEIPResponseSpec object

绑定集群公网apiserver地址的配置信息

status

status object

状态信息
表7 Metadata

参数

参数类型

描述

uid

String

唯一id标识

name

String

资源名称

labels

Map<String,String>

资源标签，key/value对格式，接口保留字段，填写不会生效

annotations

Map<String,String>

资源注解，由key/value组成

updateTimestamp

String

更新时间

creationTimestamp

String

创建时间
表8 MasterEIPResponseSpec

参数

参数类型

描述

action

String

绑定动作

spec

spec object

待绑定的弹性IP配置属性

elasticIp

String

弹性公网IP
表9 spec

参数

参数类型

描述

id

String

弹性网卡ID

eip

EipSpec object

EIP的详细信息

IsDynamic

Boolean

是否动态创建
表10 EipSpec

参数

参数类型

描述

bandwidth

bandwidth object

带宽信息
表11 bandwidth

参数

参数类型

描述

size

Integer

带宽大小

sharetype

String

带宽类型
表12 status

参数

参数类型

描述

privateEndpoint

String

集群访问的PrivateIP(HA集群返回VIP)

publicEndpoint

String

集群访问的PublicIP

请求示例

{
  "spec" : {
    "action" : "bind",
    "spec" : {
      "id" : "a757a69e-f920-455a-b1ba-d7a22db0fd50"
    }
  }
}

响应示例

状态码： 200

表示绑定集群公网apiserver地址成功，解绑成功无响应体。

{
  "metadata" : { },
  "spec" : {
    "action" : "bind",
    "spec" : {
      "id" : "a757a69e-f920-455a-b1ba-d7a22db0fd50",
      "eip" : {
        "bandwidth" : {
          "size" : 5,
          "sharetype" : "PER"
        }
      },
      "IsDynamic" : false
    },
    "elasticIp" : "8.8.8.8"
  },
  "status" : {
    "privateEndpoint" : "https://192.168.3.238:5443",
    "publicEndpoint" : "https://8.8.8.8:5443"
  }
}

状态码

状态码

描述

200

表示绑定集群公网apiserver地址成功，解绑成功无响应体。

错误码

请参见错误码。

父主题： 集群管理