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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
metadata	Metadata object	Definition Basic information. Metadata is a collection of attributes. Constraints N/A
spec	OpenAPISpec object	Definition Parameters for configuring the cluster access address Constraints N/A
status	status object	Definition Status Constraints N/A

**Table 4** 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 5** OpenAPISpec
Parameter	Type	Description
spec	spec object	Definition Cluster access address Constraints N/A

**Table 6** spec
Parameter	Type	Description
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 7** EipSpec
Parameter	Type	Description
bandwidth	bandwidth object	Definition Bandwidth information Constraints N/A

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

None

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