获取绑定的弹性公网IP列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取绑定的弹性公网IP列表

最近更新时间：2024.07.18 11:03:32首次发布时间：2024.07.02 10:22:47

本接口用于获取负载均衡绑定的弹性公网 IP 的列表。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=ListLB7EIPs&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListLB7EIPs`	接口名称。当前 API 的名称为 `ListLB7EIPs`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
lb_identity	String	是	`veew-lb72422242200104404****`	负载均衡实例的 ID。您可以调用 ListLB7Instances 获取负载均衡实例的 ID。
eip_addr	String	否	`123...158`	弹性公网 IP 地址。
cluster_name	String	否	`**cu01`	节点名称。该参数仅适用于以下场景：后端服务器为边缘容器。
cluster_alias	String	否	`**联通01`	节点的中文名称。该参数仅适用于以下场景：后端服务器为边缘容器。
pagination	Pagination	否	`见下文说明`	分页查询配置。

Pagination

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
page	Integer	否	`1`	弹性公网 IP 列表的页码。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
limit	Integer	否	`10`	分页查询时设置的每页行数。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
order_by	Integer	否	`1`	查询出来的弹性公网 IP 的排列顺序，按照绑定时间排序。取值范围： 1（默认值）：按照降序排列。 2：按照升序排列。

page

Integer

否

1

弹性公网 IP 列表的页码。
如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。

limit

Integer

否

10

分页查询时设置的每页行数。
如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。

order_by

Integer

否

1

查询出来的弹性公网 IP 的排列顺序，按照绑定时间排序。取值范围：

1（默认值）：按照降序排列。
2：按照升序排列。

返回参数

参数	类型	示例值	描述
eips	[]Eips	`见下文说明`	弹性公网 IP 的列表。
total_count	Long	`2`	弹性公网 IP 的数量。

Eips

参数	类型	示例值	描述
identity	String	`eip-h5289j****`	弹性公网 IP 的 ID。
eip_addr	String	`123...158`	弹性公网 IP 地址。
bandwidth_peak	Long	`500`	带宽峰值。单位：Mbps。
cluster_name	String	`****-zzcu01`	节点名称。
name	String	`eip-01`	弹性公网 IP 的名称。
eip_type	Integer	`1`	弹性公网 IP 的类型： 1：IPv4
region	String	`CentralChina`	区域。
city	String	`410100`	城市。
isp	String	`CUCC`	运营商。
cluster_alias	String	`**联通01`	节点的中文名称。
status	Integer	`2`	弹性公网 IP 与负载均衡实例的绑定状态： 1：申请中。 2：已绑定。 3：失败。

请求示例

POST https://veenedge.volcengineapi.com/?Action=ListLB7EIPs&Version=2021-04-30
{
    "lb_identity": "veew-lb72422242200104404****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406171115352F0D4E0C5B102C49****",
        "Action": "ListLB7EIPs",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "eips": [
            {
                "identity": "eip-7cjc6q****",
                "eip_addr": "9.**.**.218",
                "bandwidth_peak": 20,
                "cluster_name": "**ct05",
                "name": "eip-lb7-**ct05-CTCC",
                "eip_type": 1,
                "region": "EastChina",
                "city": "330200",
                "isp": "CTCC",
                "cluster_alias": "**ct05",
                "status": 2
            }
        ],
        "total_count": 1
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。