文档中心

获取弹性公网IP列表

最近更新时间：2023.07.03 16:32:36

首次发布时间：2022.02.25 18:58:31

本接口用于获取弹性公网 IP 的列表。

请求方法

GET

请求参数

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

名称	类型	是否必选	示例值	描述
Action	String	是	ListEIPInstances	公共参数。该参数表示接口名称。取值：ListEIPInstances。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
eip_identity_list	String	否	eip-wqjgxf****	弹性公网 IP 的 ID 列表。ID 之间用半角逗号（,）分隔
cluster_names	String	否	****-zzcu01	节点名称。节点之间用半角逗号（,）分隔。
fuzzy_identity	String	否	eip-wqjg	弹性公网 IP 的 ID。支持模糊查询。
fuzzy_name	String	否	nb-eip	弹性公网 IP 的名称。支持模糊查询。
fuzzy_ip	String	否		弹性公网 IP 的地址。支持模糊查询。
fuzzy_binder_name	String	否	lb4-ab	弹性公网 IP 绑定的实例的名称。支持模糊查询。
fuzzy_binder_id	String	否	veew-lb**	弹性公网 IP 绑定的实例的 ID。支持模糊查询。
with_binder_info	Boolean	否	false	是否列出绑定的实例。 true：列出绑定的实例。 false（默认值）：不列出绑定的实例。
page	Integer	否	1	弹性公网 IP 列表的页码。
limit	Integer	否	10	分页查询时设置的每页行数。
order_by	String	否	1	查询出来的弹性公网 IP 的排列顺序，按照创建时间排序。取值范围： 1：按照降序排列。 2（默认值）：按照升序排列。

返回数据

名称	类型	示例值	描述
eip_instances	[]EIPInstance	请参见返回示例	弹性公网 IP 的列表。
count	Integer	1	弹性公网 IP 的数量。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListEIPInstances&Version=2021-04-30
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230524150819619DAC9C0905D6F2****",
        "Action": "ListEIPInstances",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "eip_instances": [
            {
                "account_identity": 210000****,
                "user_identity": 0,
                "eip_identity": "eip-lkzsp****",
                "eip_name": "****-zjct02-CTCC",
                "cluster": {
                    "cluster_name": "****-zjct02",
                    "country": "CN",
                    "region": "EastChina",
                    "province": "ZJ",
                    "city": "330600",
                    "isp": "CTCC",
                    "level": "3",
                    "alias": "绍兴电信01"
                },
                "eip_type": "IPv4",
                "eip_addr": "115.**.**.4",
                "bandwidth_peak": 20,
                "isp": "CTCC",
                "network_type": "public",
                "status": "bound",
                "desc": "",
                "billing_config": {
                    "ip_billing_method": "MonthlyPeak",
                    "bandwidth_billing_method": "MonthlyP95"
                },
                "cluster_bwp_id": 67**,
                "create_time": 1672818553,
                "update_time": 1679884662
            },
            {
                "account_identity": 210000****,
                "user_identity": 0,
                "eip_identity": "eip-r9bn5l****",
                "eip_name": "****-fjfzct01-CTCC",
                "cluster": {
                    "cluster_name": "****-fjfzct01",
                    "country": "CN",
                    "region": "EastChina",
                    "province": "FJ",
                    "city": "350100",
                    "isp": "CTCC",
                    "level": "2",
                    "alias": "福州电信01"
                },
                "eip_type": "IPv4",
                "eip_addr": "117.**.**.133",
                "bandwidth_peak": 20,
                "isp": "CTCC",
                "network_type": "public",
                "status": "unbound",
                "desc": "",
                "billing_config": {
                    "ip_billing_method": "MonthlyPeak",
                    "bandwidth_billing_method": "MonthlyP95"
                },
                "cluster_bwp_id": 72**,
                "create_time": 1684910017,
                "update_time": 1684910018
            }
        ],
        "count": 2
    }
}

错误码

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

请求方法

请求参数

返回数据

请求示例

返回示例

错误码

边缘计算节点

获取弹性公网IP列表

请求方法

请求参数

返回数据

请求示例

返回示例

错误码