Help Center/ Cloud Application Engine/ API Reference/ CAE API/ EIP/ Obtaining the EIP List of Cluster Nodes

Updated on 2025-02-14 GMT+08:00

View PDF

Obtaining the EIP List of Cluster Nodes

Function

This API is used to obtain the EIP list of cluster nodes.

URI

GET /v1/{project_id}/cae/eips

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. See Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. To obtain a token, see Obtaining a User Token Through Password Authentication. After a response is returned, the value of X-Subject-Token in the response header is the token value. Maximum characters: 16,384
X-Enterprise-Project-ID	No	String	Enterprise project ID. When an environment is created, it will be bound with an enterprise project ID. Enter 0 or up to 36 characters in UUID format with hyphens (-). If this parameter is not specified or set to 0, resources in the default enterprise project are queried. NOTE: For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List in CAE API Reference. In the response, id under items indicates the environment ID.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
api_version	String	API version. Fixed value: v1. Enumerated value: v1
kind	String	API type. Fixed value: eip. Enumerated value: eip
spec	spec object	Inbound and outbound EIP information.

**Table 4** spec
Parameter	Type	Description
egress	egress object	Outbound IP address.
ingress	ingress object	Inbound IP address.

**Table 5** egress
Parameter	Type	Description
bandwidth_size	Integer	Outbound bandwidth.
ip_list	Array of strings	List of outbound IP addresses.

**Table 6** ingress
Parameter	Type	Description
bandwidth_size	Integer	Inbound bandwidth.
ip_list	Array of strings	List of inbound IP addresses.

Example Request

Obtain the EIP list.

GET https://{endpoint}/v1/{project_id}/cae/eips

Example Response

Status code: 200

The request is successful.

{
  "api_version" : "v1",
  "kind" : "eip",
  "spec" : {
    "egress" : {
      "bandwidth_size" : 20,
      "ip_list" : [ "192.168.1.1", "192.168.1.2" ]
    },
    "ingress" : {
      "bandwidth_size" : 20,
      "ip_list" : [ "192.168.1.3" ]
    }
  }
}