DescFreeEipList-查询可绑定的防护资源信息--DDoS防护-火山引擎

文档中心

立即注册

导航

DescFreeEipList-查询可绑定的防护资源信息

最近更新时间：2025.05.28 18:54:51首次发布时间：2024.06.18 17:30:59

查询指定实例下可绑定的防护资源列表，可根据资源类型进行筛选。

注意事项

调用时请将{region}替换成实际地域 ID，地域详情参见地域信息。

请求说明

请求方式：GET
请求地址：https://origin_defence.{region}.volcengineapi.com/?Action=DescFreeEipList&Version=2022-01-01

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescFreeEipList`	接口名称。当前 API 的名称为 `DescFreeEipList`。
Version	String	是	`2022-01-01`	接口版本。当前 API 的版本为 `2022-01-01`。
EipInsTypes	String	否	`EcsInstance,WafInstance`	按防护 EIP 绑定的资源类型筛选列表，多个类型之间以逗号分隔，值为空时或不传参时查询全部资源类型。 EcsInstance：云服务器 Nat：NAT 网关 ClbInstance：负载均衡 NetworkInterface：辅助网卡 HaVip：高可用虚拟 IP AlbInstance：应用型负载均衡 WafInstance：Web 应用防火墙 InternetTunnel：互联网通道 Idle：未绑定
GetAll	Boolean	是	`True`	全量或分页展示查询到的列表信息。 True：全量返回，不分页。 False：分页展示，且默认每个页面展示 10 个条目。说明分页展示仅对企业版生效。
InsId	Integer	是	`43`	防护实例的 ID，可调用 DescInstanceList 接口获取具体值。

返回参数

参数	类型	示例值	描述
PageInfo	Object of PageInfo	`--`	分页信息。
Result	Object of Result	`--`	列表详情。

PageInfo

参数	类型	示例值	描述
Count	Integer	`10`	当前页面显示的条目数量。
CurrentPage	Integer	`1`	当前页面的页码。
PageSize	Integer	`20`	单个页面显示的条目数量上限。
TotalCount	Integer	`15`	查询到的符合条件的条目总数。

Result

参数	类型	示例值	描述
CanBindNum	Integer	`48`	当前实例可添加的防护 EIP 数量。
EipList	Array of EipList	`--`	可添加的 EIP 详情。

EipList

参数	类型	示例值	描述
BindId	String	`WAF7346002284446138412`	资源实例的 ID。
BindType	String	`WafInstance`	资源类型。 EcsInstance：云服务器 Nat：NAT 网关 ClbInstance：负载均衡 NetworkInterface：辅助网卡 HaVip：高可用虚拟 IP AlbInstance：应用型负载均衡 WafInstance：Web 应用防火墙 InternetTunnel：互联网通道为空：未绑定
EipId	String	`eip-3refg7ooi4fls5zsk2ibd****`	EIP 资源的 ID，当 BindType=InternetTunnel 时，为互联网通道的 ID。
EipName	String	`WAFnyqhgLyW`	EIP 资源的名称，当 BindType=InternetTunnel 时，为互联网通道的名称。
Ip	String	`33.33.32.**`	EIP 资源的 IP 地址，当 BindType=InternetTunnel 时，为互联网通道的 IP 地址段。
IpVersion	Integer	`4`	IP 地址格式。 4：IPv4 6：IPv6
StartTime	String	`2024-06-03 16:34:21 +0800 CST`	EIP 资源或互联网通道的开通时间。

请求示例

GET https://origin_defence.{region}.volcengineapi.com/?Action=DescFreeEipList&Version=2022-01-01&EipInsTypes=EcsInstance,WafInstance&GetAll=True&InsId=43

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescFreeEipList",
        "Version": "2022-01-01",
        "Service": "origin_defence",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageInfo": {
            "Count": 10,
            "CurrentPage": 1,
            "PageSize": 20,
            "TotalCount": 15
        },
        "Result": {
            "CanBindNum": 48,
            "EipList": [
                {
                    "BindId": "WAF7346002284446138412",
                    "BindType": "WafInstance",
                    "EipId": "eip-3refg7ooi4fls5zsk2ibd****",
                    "EipName": "WAFnyqhgLyW",
                    "Ip": "33.33.32.**",
                    "IpVersion": 4,
                    "StartTime": "2024-06-03 16:34:21 +0800 CST"
                }
            ]
        }
    }
}