绑定、解绑集群公网apiserver地址
功能介绍
该API用于通过集群ID绑定、解绑集群公网apiserver地址
集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径。
调用方法
请参见如何调用API。
URI
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/mastereip
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 账号的项目ID 默认取值: 不涉及 |
cluster_id |
是 |
String |
参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 集群ID 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
参数解释: 消息体的类型(格式) 约束限制: GET方法不做校验 取值范围:
默认取值: 不涉及 |
X-Auth-Token |
是 |
String |
参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
spec |
是 |
MasterEIPRequestSpec object |
绑定、解绑集群公网apiserver地址的请求配置参数 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
否 |
String |
绑定或解绑动作,必选参数。
|
spec |
否 |
spec object |
待绑定的弹性IP配置属性 |
bandwidth |
否 |
String |
带宽(字段已失效,暂不推荐使用) |
elasticIp |
否 |
String |
弹性网卡IP(字段已失效,暂不推荐使用) |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
metadata |
Metadata object |
基本信息,为集合类的元素类型,包含一组由不同名称定义的属性 |
spec |
MasterEIPResponseSpec object |
绑定集群公网apiserver地址的配置信息 |
status |
status object |
状态信息 |
参数 |
参数类型 |
描述 |
---|---|---|
uid |
String |
唯一id标识 |
name |
String |
资源名称 |
labels |
Map<String,String> |
资源标签,key/value对格式,接口保留字段,填写不会生效 |
annotations |
Map<String,String> |
资源注解,由key/value组成 |
updateTimestamp |
String |
更新时间 |
creationTimestamp |
String |
创建时间 |
参数 |
参数类型 |
描述 |
---|---|---|
action |
String |
绑定动作 |
spec |
spec object |
待绑定的弹性IP配置属性 |
elasticIp |
String |
弹性公网IP |
请求示例
绑定集群公网apiserver地址。
{ "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地址成功,解绑成功无响应体。 |
错误码
请参见错误码。