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.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
cluster_id	Yes	String	Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format).
X-Auth-Token	Yes	String	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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
spec	Yes	MasterEIPRequestSpec object	Parameters in the request for binding or unbinding the public APIServer address of a cluster

**Table 4** MasterEIPRequestSpec
Parameter	Mandatory	Type	Description
action	No	String	Binding or unbinding. Mandatory. Binding: The value is fixed at {"action":"bind"}. Unbinding: The value is fixed at {"action":"unbind"}.
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.)

**Table 5** spec
Parameter	Mandatory	Type	Description
id	No	String	Specifies the ENI ID. This parameter is mandatory for binding an ENI and is invalid for unbinding an ENI.

Response Parameters

Status code: 200

**Table 6** Response body parameters
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

**Table 7** Metadata
Parameter	Type	Description
uid	String	Unique ID.
name	String	Add-on name.
labels	Map<String,String>	Add-on labels in key-value pairs. This is a reserved field and does not take effect.
annotations	Map<String,String>	Add-on annotations in the format of key-value pairs. For add-on installation, the value is fixed at {"addon.install/type":"install"}. For add-on upgrade, the value is fixed at {"addon.upgrade/type":"upgrade"}.
updateTimestamp	String	Update time.
creationTimestamp	String	Creation time.

**Table 8** MasterEIPResponseSpec
Parameter	Type	Description
action	String	A binding operation
spec	spec object	Configuration attributes of the elastic IP address to be bound
elasticIp	String	EIP

**Table 9** spec
Parameter	Type	Description
id	String	ENI ID
eip	EipSpec object	EIP details
IsDynamic	Boolean	Dynamic provisioning or not

**Table 10** EipSpec
Parameter	Type	Description
bandwidth	bandwidth object	Bandwidth information

**Table 11** bandwidth
Parameter	Type	Description
size	Integer	Bandwidth size
sharetype	String	Bandwidth type

**Table 12** status
Parameter	Type	Description
privateEndpoint	String	Private IP for accessing the cluster (VIP in the case of an HA cluster)
publicEndpoint	String	Public IP for accessing the cluster

Example Requests

{
  "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.