文档首页/ 云应用引擎 CAE/ API参考/ CAE API/ 弹性公网IP/ 获取集群节点弹性公网IP列表 - ListEips
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

获取集群节点弹性公网IP列表 - ListEips

功能介绍

获取集群节点弹性公网IP列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/cae/eips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

  • 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。

    • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

否

String

企业项目ID。

  • 创建环境时，环境会绑定企业项目ID。

  • 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。

说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

X-Environment-ID

是

String

环境ID。

  • 获取环境ID，通过获取环境列表来获取环境信息。

  • 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

api_version

String

API版本，固定值“v1”，该值不可修改。

kind

String

API类型，固定值“Eip”，该值不可修改。

spec

spec object

出入网公网IP信息。
表4 spec

参数

参数类型

描述

egress

egress object

出网IP信息。

ingress

ingress object

入网IP信息。
表5 egress

参数

参数类型

描述

bandwidth_size

Integer

出网IP带宽。

enabled

Boolean

是否关闭出网IP。

ip_list

Array of strings

出网IP列表。
表6 ingress

参数

参数类型

描述

bandwidth_size

Integer

入网IP带宽

enabled

Boolean

是否关闭入网IP。

ip_list

Array of strings

入网IP列表

请求示例

获取弹性公网IP列表。

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

响应示例

状态码：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" ]
    }
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题： 弹性公网IP

相关文档