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

Updated on 2025-10-22 GMT+08:00

View PDF

Obtaining the EIP List of Cluster Nodes

Function

Obtain the EIP list of cluster nodes.

URI

GET /v1/{project_id}/cae/eips

**Table 1** Path Parameters
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. Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html). The value of X-Subject-Token in the response header is the token value.
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 details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List. 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.
kind	String	API type. Fixed 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.
enabled	Boolean	Whether to disable the outbound IP address.
ip_list	Array of strings	List of outbound IP addresses.

**Table 6** ingress
Parameter	Type	Description
bandwidth_size	Integer	Inbound bandwidth.
enabled	Boolean	Whether to disable the inbound IP address.
ip_list	Array of strings	List of inbound IP addresses.

Example Requests

Obtain the EIP list.

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

Example Responses

Status code: 200

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