DescResourceList-查询实例已绑定的防护资源--DDoS防护-火山引擎

文档中心

立即注册

导航

DescResourceList-查询实例已绑定的防护资源

最近更新时间：2024.06.27 22:21:30首次发布时间：2024.06.18 17:30:59

获取指定实例下已绑定的防护资源列表信息，包括当前实例支持绑定的资源数量、已经绑定的资源数量和已绑定 EIP 的详细信息。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com/?Action=DescResourceList&Version=2022-01-01

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescResourceList`	接口名称。当前 API 的名称为 `DescResourceList`。
Version	String	是	`2022-01-01`	接口版本。当前 API 的版本为 `2022-01-01`。
InsId	Integer	是	`43`	防护实例的 ID，可调用 DescInstanceList 接口获取具体值。
CurrPage	Integer	否	`1`	查询结果展示的页码，即第几页。不填则默认展示第 1 页的查询结果。
PageSize	Integer	否	`10`	每个页面展示的结果数量，可选范围为 10～100 区间内的整数。不填则默认展示 10 个。
SearchIp	String	否	`10.249.206.**`	按防护资源的 IP 地址/地址段进行模糊匹配。
SearchEipId	String	否	`eip-3refg7ooi4fls5zsk2ibd****`	按防护资源的 ID 进行模糊匹配。
SearchEipName	String	否	`WAFnyqhgLyW`	按防护资源的名称进行模糊匹配。
Status	String	否	`normal`	按防护资源状态筛选列表，多个类型之间以逗号分隔，值为空时或不传参时为全展示。 normal：正常 cleaning：清洗中 blocking：黑洞中
EipInsTypes	String	否	`EcsInstance`	按防护资源绑定的类型筛选列表，多个类型之间以逗号分隔，值为空时或不传参时查询全部资源类型。 EcsInstance：云服务器 Nat：NAT 网关 ClbInstance：负载均衡 NetworkInterface：辅助网卡 HaVip：高可用虚拟 IP AlbInstance：应用型负载均衡 WafInstance：Web 应用防火墙 InternetTunnel：互联网通道 Idle：未绑定

返回参数

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

PageInfo

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

Result

参数	类型	示例值	描述
BlockReleaseRemain	Integer	`5`	当日黑洞解封剩余次数。
IpList	Array of IpList	`--`	防护资源的详细信息。
IpReserved	Integer	`3`	预占资源配额数，仅增强型防护 EIP 涉及。创建 ECS 实例时绑定企业版防护资源包，此时需要预占原生防护资源配额，该预占配额数量为需要创建的 ECS 实例数量。更多预占资源的说明，可参考弹性预约实例概述。
IpTotal	Integer	`10`	当前实例下可添加的防护 EIP 总数。
IpUsed	Integer	`3`	当前实例下已添加的防护 EIP 数量。

IpList

参数	类型	示例值	描述
AttackStatus	String	`normal`	防护资源状态。 normal：正常 cleaning：清洗中 blocking：黑洞中
BindId	String	`WAF7346002284446138412`	资源实例的 ID。
BindStatus	String	`used`	资源与防护实例的绑定状态。 used：已绑定 standby：未绑定
BindType	String	`EcsInstance`	防护 EIP 绑定的资源类型。 EcsInstance：云服务器 Nat：NAT 网关 ClbInstance：负载均衡 NetworkInterface：辅助网卡 HaVip：高可用虚拟 IP AlbInstance：应用型负载均衡 WafInstance：Web 应用防火墙 InternetTunnel：互联网通道为空：未绑定
BlockEnd	Integer	`1718697249`	黑洞预计解封时间，秒级时间戳。
BlockType	Integer	`1`	防护资源的黑洞状态。 0：未黑洞 1：全部线路黑洞 2：部分线路黑洞
Cidr	String	`10.249.206.**/30`	当 EIP 绑定互联网通道资源，即 BindType=InternetTunnel 时，该参数返回对应的 IP 地址段信息，否则为空。
EipId	String	`eip-3refg7ooi4fls5zsk2ibd****`	资源实例所属 EIP 资源的 ID。
EipName	String	`WAFnyqhgLyW`	资源实例的名称。
Ip	String	`10.249.206.**`	EIP 资源的 IP 地址。
IpVersion	Integer	`4`	IP 地址格式。 4：IPv4 6：IPv6

请求示例

GET https://open.volcengineapi.com/?Action=DescResourceList&Version=2022-01-01&InsId=43
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240610T082509Z
X-content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240610/cn-beijing/origin_defence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
    "ResponseMetadata": {
        "Action": "DescResourceList",
        "Region": "cn-beijing",
        "RequestId": "20230604110420****100232280022D31",
        "Service": "origin_defence",
        "Version": "2022-01-01"
    },
    "Result": {
        "BlockReleaseRemain": 5,
        "IpList": [
            {
                "Ip": "10.249.180.**",
                "BindType": "EcsInstance",
                "BindId": "i-ycdgknnwayexzkhf****",
                "BindStatus": "used",
                "AttackStatus": "normal",
                "EipName": "eip-2d66de1mr21vk58ozfd4pc5lr",
                "EipId": "eip-2d66de1mr21vk58ozfd4p****",
                "IpVersion": 4,
                "Cidr": ""
            },
        ],
        "IpReserved": 0,
        "IpTotal": 10,
        "IpUsed": 3
    },
    "PageInfo": {
        "Count": 1,
        "CurrentPage": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}