Updated on 2026-09-30 GMT+08:00

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.

Calling Method

For details, see Calling APIs.

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	Definition: Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints: GET requests are not validated. Range: N/A 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.
spec	OpenAPISpec object	Definition Parameters for configuring the cluster access address
status	status object	Definition Status

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

**Table 5** OpenAPISpec
Parameter	Type	Description
spec	spec object	Definition Cluster access address

**Table 6** spec
Parameter	Type	Description
eip	EipSpec object	Definition EIP details
IsDynamic	Boolean	Definition Dynamic provisioning or not Range N/A

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

**Table 8** bandwidth
Parameter	Type	Description
size	Integer	Definition Bandwidth size Range N/A
sharetype	String	Definition Bandwidth type Range PER: dedicated bandwidth. A dedicated bandwidth can only be used by one EIP. Each EIP can only be bound to one cloud resource, such as an ECS, a NAT gateway, or a load balancer. WHOLE: shared bandwidth. A shared bandwidth can be used by multiple pay-per-use EIPs.

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

Example Requests

None

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	The cluster access address is obtained successfully.

Error Codes

See Error Codes.

Parent topic: Cluster Management