Binding/Unbinding Public API Server Address
Function
This API is used to bind or unbind the public API server address of the cluster by cluster ID.
The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.
Calling Method
For details, see Calling APIs.
URI
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/mastereip
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A |
cluster_id |
Yes |
String |
Details: Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Details: Request body type or format Constraints: The GET method is not verified. Options:
Default value: N/A |
X-Auth-Token |
Yes |
String |
Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
spec |
Yes |
MasterEIPRequestSpec object |
Parameters in the request for binding or unbinding the public APIServer address of a cluster |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
action |
No |
String |
Binding or unbinding. Mandatory.
|
spec |
No |
spec object |
Configuration attributes of the elastic IP address to be bound |
bandwidth |
No |
String |
Bandwidth (This field has expired and is not recommended.) |
elasticIp |
No |
String |
ENI IP (This field has expired and is not recommended.) |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
metadata |
Metadata object |
Basic information about the object. Metadata is a collection of attributes. |
spec |
MasterEIPResponseSpec object |
Configuration of the bound public APIServer address of a cluster |
status |
status object |
Status information |
Parameter |
Type |
Description |
---|---|---|
uid |
String |
Unique ID. |
name |
String |
Resource name |
labels |
Map<String,String> |
Resource labels in key-value pairs. This is a reserved field and does not take effect. |
annotations |
Map<String,String> |
Resource annotations in the format of key-value pairs. |
updateTimestamp |
String |
Update time. |
creationTimestamp |
String |
Creation time. |
Parameter |
Type |
Description |
---|---|---|
action |
String |
A binding operation |
spec |
spec object |
Configuration attributes of the elastic IP address to be bound |
elasticIp |
String |
EIP |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ENI ID |
eip |
EipSpec object |
EIP details |
IsDynamic |
Boolean |
Dynamic provisioning or not |
Example Requests
Bind the public API server address to a cluster.
{ "spec" : { "action" : "bind", "spec" : { "id" : "a757a69e-f920-455a-b1ba-d7a22db0fd50" } } }
Example Responses
Status code: 200
This indicates that the public API server address of the cluster is successfully bound. No response body is returned if the unbinding is successful.
{ "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 Sample Code
The SDK sample code is as follows.
Bind the public API server address to a cluster.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
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 UpdateClusterEipSolution { 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("<YOUR REGION>")) .build(); UpdateClusterEipRequest request = new UpdateClusterEipRequest(); request.withClusterId("{cluster_id}"); MasterEIPRequest body = new MasterEIPRequest(); MasterEIPRequestSpecSpec specSpec = new MasterEIPRequestSpecSpec(); specSpec.withId("a757a69e-f920-455a-b1ba-d7a22db0fd50"); MasterEIPRequestSpec specbody = new MasterEIPRequestSpec(); specbody.withAction(MasterEIPRequestSpec.ActionEnum.fromValue("bind")) .withSpec(specSpec); body.withSpec(specbody); request.withBody(body); try { UpdateClusterEipResponse response = client.updateClusterEip(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()); } } } |
Bind the public API server address to a cluster.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
# 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("<YOUR REGION>")) \ .build() try: request = UpdateClusterEipRequest() request.cluster_id = "{cluster_id}" specSpec = MasterEIPRequestSpecSpec( id="a757a69e-f920-455a-b1ba-d7a22db0fd50" ) specbody = MasterEIPRequestSpec( action="bind", spec=specSpec ) request.body = MasterEIPRequest( spec=specbody ) response = client.update_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) |
Bind the public API server address to a cluster.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
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("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateClusterEipRequest{} request.ClusterId = "{cluster_id}" idSpec:= "a757a69e-f920-455a-b1ba-d7a22db0fd50" 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.UpdateClusterEip(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
This indicates that the public API server address of the cluster is successfully bound. No response body is returned if the unbinding is successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot