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

**Table 1** Path Parameters
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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Details: The request body type or format Constraints: The GET method is not verified. Options: application/json application/json;charset=utf-8 application/x-pem-file multipart/form-data (used when the FormData parameter is present) 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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
spec	Yes	MasterEIPRequestSpec object	Definition Request parameters for binding or unbinding the public API server address of a cluster Constraints N/A

**Table 4** MasterEIPRequestSpec
Parameter	Mandatory	Type	Description
action	Yes	String	Definition Binding or unbinding action Constraints N/A Range bind: specifies the binding action. unbind: specifies the unbinding action. Default Value N/A
spec	No	spec object	Definition Configuration attributes of the EIP to be bound Constraints N/A Range N/A Default Value N/A
bandwidth	No	String	Definition Bandwidth (This field has expired and is not recommended.) Constraints N/A Range N/A Default Value N/A
elasticIp	No	String	Definition EIP (This field has expired and is not recommended.) Constraints N/A Range N/A Default Value N/A

**Table 5** spec
Parameter	Mandatory	Type	Description
id	No	String	Definition EIP ID. This parameter is mandatory for binding an EIP and is invalid for unbinding an EIP. NOTE: To obtain the ID, log in to the management console, choose Service List > Networking > Elastic IP, click the EIP name to access the details page, and copy the ID on the Summary tab. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
metadata	Metadata object	Definition Basic information. Metadata is a collection of attributes. Constraints N/A
spec	MasterEIPResponseSpec object	Definition Configuration about the public API server address bound to a cluster Constraints N/A
status	status object	Definition Status Constraints N/A

**Table 7** Metadata
Parameter	Type	Description
uid	String	Definition Unique ID Constraints N/A Range N/A Default Value N/A
name	String	Definition Resource name Constraints N/A Range N/A Default Value N/A
labels	Map<String,String>	Definition Resource labels in key-value pairs. This is a reserved field. Inputting values will not work. Constraints N/A Range N/A Default Value N/A
annotations	Map<String,String>	Definition Resource annotations in the format of key-value pairs Constraints N/A Range N/A Default Value N/A
updateTimestamp	String	Definition Update time Constraints N/A Range N/A Default Value N/A
creationTimestamp	String	Definition Creation time Constraints N/A Range N/A Default Value N/A

**Table 8** MasterEIPResponseSpec
Parameter	Type	Description
action	String	Definition Binding action Constraints N/A Range N/A Default Value N/A
spec	spec object	Definition Configuration attributes of the EIP to be bound Constraints N/A
elasticIp	String	Definition EIP Constraints N/A Range N/A Default Value N/A

**Table 9** spec
Parameter	Type	Description
id	String	Definition EIP ID Constraints N/A Range N/A Default Value N/A
eip	EipSpec object	Definition EIP details Constraints N/A
IsDynamic	Boolean	Definition Dynamic provisioning or not Constraints N/A Range N/A Default Value N/A

**Table 10** EipSpec
Parameter	Type	Description
bandwidth	bandwidth object	Definition Bandwidth information Constraints N/A

**Table 11** bandwidth
Parameter	Type	Description
size	Integer	Definition Bandwidth size Constraints N/A Range N/A Default Value N/A
sharetype	String	Definition Bandwidth type Constraints N/A Range PER: dedicated bandwidth WHOLE: shared bandwidth Default Value N/A

**Table 12** status
Parameter	Type	Description
privateEndpoint	String	Definition Private IP address for accessing a cluster (VIP in the case of an HA cluster) Constraints N/A Range N/A Default Value N/A
publicEndpoint	String	Definition Public IP address for accessing a cluster Constraints N/A Range N/A Default Value N/A

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"
  }
}

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.