Obtaining Cluster Access Address

Function

This API is used to obtain the cluster access addresses by cluster ID, including the private IP (VIP returned by an HA cluster) and public IP.

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

GET /api/v3/projects/{project_id}/clusters/{cluster_id}/openapi

**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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
metadata	Metadata object	Basic information about the object. Metadata is a collection of attributes.
spec	OpenAPISpec object	Parameters for configuring the address for accessing the cluster
status	status object	Status information

**Table 4** 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 5** OpenAPISpec
Parameter	Type	Description
spec	spec object	Address for accessing the cluster

**Table 6** spec
Parameter	Type	Description
eip	EipSpec object	EIP details
IsDynamic	Boolean	Dynamic provisioning or not

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

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

**Table 9** 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

{
  "metadata" : { },
  "spec" : {
    "spec" : {
      "eip" : {
        "bandwidth" : { }
      },
      "IsDynamic" : false
    }
  },
  "status" : {
    "privateEndpoint" : "https://192.168.3.238:5443",
    "publicEndpoint" : ""
  }
}

Example Responses

Status code: 200

The cluster access address is obtained successfully.

{
  "metadata" : { },
  "spec" : {
    "spec" : {
      "eip" : {
        "bandwidth" : { }
      },
      "IsDynamic" : false
    }
  },
  "status" : {
    "privateEndpoint" : "https://192.168.3.238:5443",
    "publicEndpoint" : ""
  }
}