# 绑定、解绑集群公网apiserver地址 - UpdateAutopilotClusterEip #### 功能介绍 该API用于通过集群ID绑定、解绑集群公网apiserver地址 ![](https://support.huaweicloud.com/api-cce-autopilot/public_sys-resources/note_3.0-zh-cn.png) 集群管理的URL格式为：https://Endpoint/uri。其中uri为资源路径，也即API访问的路径。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0099.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0327.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cce:cluster:eipBinding | Write | cluster \* | - g:EnterpriseProjectId - g:ResourceTag/\ | - cce:cluster:update | - | #### URI PUT /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/mastereip 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0271.html)。 **约束限制：** 不涉及 **取值范围：** 账号的项目ID **默认取值：** 不涉及 | | cluster_id | 是 | String | **参数解释：** 集群ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0271.html)。 **约束限制：** 不涉及 **取值范围：** 集群ID **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式），默认为application/json，有其他取值时会在具体接口中专门说明。 **约束限制：** GET方法不做校验 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见[获取token](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0004.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | spec | 是 | [MasterEIPRequestSpec] object | **参数解释**： 绑定、解绑集群公网apiserver地址的请求配置参数 **约束限制**： 不涉及 | 表4MasterEIPRequestSpec | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | action | 是 | String | **参数解释**： 绑定或解绑动作 **约束限制**： 不涉及 **取值范围**： - bind：绑定 - unbind：解绑 **默认取值**： 不涉及 | | spec | 否 | [spec] object | **参数解释**： 待绑定的弹性IP配置属性 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | bandwidth | 否 | String | **参数解释**： 带宽(字段已失效，暂不推荐使用) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | elasticIp | 否 | String | **参数解释**： 弹性网卡IP(字段已失效，暂不推荐使用) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表5spec | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | **参数解释**： 弹性网卡ID，绑定时必选，解绑时该字段无效 说明： 获取方式:在控制台的"服务列表"中，单击"网络 \> 弹性公网IP EIP"，单击弹性公网IP，在详情页的"基本信息"页签下找到"ID"字段复制即可。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metadata | [Metadata] object | **参数解释**： 基本信息，为集合类的元素类型，包含一组由不同名称定义的属性 **约束限制**： 不涉及 | | spec | [MasterEIPResponseSpec] object | **参数解释**： 绑定集群公网apiserver地址的配置信息 **约束限制**： 不涉及 | | status | [status] object | **参数解释**： 状态信息 **约束限制**： 不涉及 | 表7Metadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uid | String | **参数解释**： 唯一id标识 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | name | String | **参数解释**： 资源名称 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | labels | Map\ | **参数解释**： 资源标签，key/value对格式，接口保留字段，填写不会生效 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | annotations | Map\ | **参数解释**： 资源注解，由key/value组成 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | updateTimestamp | String | **参数解释**： 更新时间 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | creationTimestamp | String | **参数解释**： 创建时间 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表8MasterEIPResponseSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | action | String | **参数解释**： 绑定动作 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | spec | [spec] object | **参数解释**： 待绑定的弹性IP配置属性 **约束限制**： 不涉及 | | elasticIp | String | **参数解释**： 弹性公网IP **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表9spec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 弹性网卡ID **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | eip | [EipSpec] object | **参数解释**： EIP的详细信息 **约束限制**： 不涉及 | | IsDynamic | Boolean | **参数解释**： 是否动态创建 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | 表10EipSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bandwidth | [bandwidth] object | **参数解释**： 带宽信息 **约束限制**： 不涉及 | 表11bandwidth | 参数 | 参数类型 | 描述 | |:---|:---|:---| | size | Integer | **参数解释**： 带宽大小 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | sharetype | String | **参数解释**： 带宽类型 **约束限制**： 不涉及 **取值范围**： - PER：独享带宽 - WHOLE：共享带宽 **默认取值**： 不涉及 | 表12status | 参数 | 参数类型 | 描述 | |:---|:---|:---| | privateEndpoint | String | **参数解释**： 集群访问的PrivateIP(HA集群返回VIP) **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | | publicEndpoint | String | **参数解释**： 集群访问的PublicIP **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 | #### 请求示例 绑定集群公网apiserver地址。 ``` { "spec" : { "action" : "bind", "spec" : { "id" : "a757a69e-f920-455a-b1ba-d7a22db0fd51" } } } ``` #### 响应示例 **状态码：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" } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 绑定集群公网apiserver地址。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cce.v3.region.CceRegion; import com.huaweicloud.sdk.cce.v3.*; import com.huaweicloud.sdk.cce.v3.model.*; public class UpdateAutopilotClusterEipSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CceClient client = CceClient.newBuilder() .withCredential(auth) .withRegion(CceRegion.valueOf("")) .build(); UpdateAutopilotClusterEipRequest request = new UpdateAutopilotClusterEipRequest(); request.withClusterId("{cluster_id}"); MasterEIPRequest body = new MasterEIPRequest(); MasterEIPRequestSpecSpec specSpec = new MasterEIPRequestSpecSpec(); specSpec.withId("a757a69e-f920-455a-b1ba-d7a22db0fd51"); MasterEIPRequestSpec specbody = new MasterEIPRequestSpec(); specbody.withAction(MasterEIPRequestSpec.ActionEnum.fromValue("bind")) .withSpec(specSpec); body.withSpec(specbody); request.withBody(body); try { UpdateAutopilotClusterEipResponse response = client.updateAutopilotClusterEip(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 绑定集群公网apiserver地址。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcce.v3.region.cce_region import CceRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcce.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CceClient.new_builder() \ .with_credentials(credentials) \ .with_region(CceRegion.value_of("")) \ .build() try: request = UpdateAutopilotClusterEipRequest() request.cluster_id = "{cluster_id}" specSpec = MasterEIPRequestSpecSpec( id="a757a69e-f920-455a-b1ba-d7a22db0fd51" ) specbody = MasterEIPRequestSpec( action="bind", spec=specSpec ) request.body = MasterEIPRequest( spec=specbody ) response = client.update_autopilot_cluster_eip(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 绑定集群公网apiserver地址。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cce.NewCceClient( cce.CceClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). Build()) request := &model.UpdateAutopilotClusterEipRequest{} request.ClusterId = "{cluster_id}" idSpec:= "a757a69e-f920-455a-b1ba-d7a22db0fd51" specSpec := &model.MasterEipRequestSpecSpec{ Id: &idSpec, } actionSpec:= model.GetMasterEipRequestSpecActionEnum().BIND specbody := &model.MasterEipRequestSpec{ Action: &actionSpec, Spec: specSpec, } request.Body = &model.MasterEipRequest{ Spec: specbody, } response, err := client.UpdateAutopilotClusterEip(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CCE/sdk?api=UpdateAutopilotClusterEip)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 表示绑定集群公网apiserver地址成功，解绑成功无响应体。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cce-autopilot/ErrorCode.html)。