You need to enable JavaScript to run this app.
导航
DescResourceList-查询实例已绑定的防护资源
最近更新时间:2025.05.28 18:54:51首次发布时间:2024.06.18 17:30:59
我的收藏
有用
有用
无用
无用

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

注意事项

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

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionStringDescResourceList接口名称。当前 API 的名称为 DescResourceList
VersionString2022-01-01接口版本。当前 API 的版本为 2022-01-01
InsIdInteger43防护实例的 ID,可调用 DescInstanceList 接口获取具体值。
CurrPageInteger1查询结果展示的页码,即第几页。不填则默认展示第 1 页的查询结果。
PageSizeInteger10每个页面展示的结果数量,可选范围为 10~100 区间内的整数。不填则默认展示 10 个。
SearchIpString10.249.206.**按防护资源的 IP 地址/地址段进行模糊匹配。
SearchEipIdStringeip-3refg7ooi4fls5zsk2ibd****按防护资源的 ID 进行模糊匹配。
SearchEipNameStringWAFnyqhgLyW按防护资源的名称进行模糊匹配。

Status

String

normal

按防护资源状态筛选列表,多个类型之间以逗号分隔,值为空时或不传参时为全展示。

  • normal:正常
  • cleaning:清洗中
  • blocking:黑洞中

EipInsTypes

String

EcsInstance

按防护资源绑定的类型筛选列表,多个类型之间以逗号分隔,值为空时或不传参时查询全部资源类型。

  • EcsInstance:云服务器
  • Nat:NAT 网关
  • ClbInstance:负载均衡
  • NetworkInterface:辅助网卡
  • HaVip:高可用虚拟 IP
  • AlbInstance:应用型负载均衡
  • WafInstance:Web 应用防火墙
  • InternetTunnel:互联网通道
  • Idle:未绑定

返回参数

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

PageInfo

参数类型示例值描述
CountInteger10当前页面显示的条目数量。
CurrentPageInteger1当前页面的页码。
PageSizeInteger20单个页面显示的条目数量上限。
TotalCountInteger15查询到的符合条件的条目总数。

Result

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

IpList

参数类型示例值描述

AttackStatus

String

normal

防护资源状态。

  • normal:正常
  • cleaning:清洗中
  • blocking:黑洞中
BindIdStringWAF7346002284446138412资源实例的 ID。

BindStatus

String

used

资源与防护实例的绑定状态。

  • used:已绑定
  • standby:未绑定

BindType

String

EcsInstance

防护 EIP 绑定的资源类型。

  • EcsInstance:云服务器
  • Nat:NAT 网关
  • ClbInstance:负载均衡
  • NetworkInterface:辅助网卡
  • HaVip:高可用虚拟 IP
  • AlbInstance:应用型负载均衡
  • WafInstance:Web 应用防火墙
  • InternetTunnel:互联网通道
  • 为空:未绑定
BlockEndInteger1718697249黑洞预计解封时间,秒级时间戳。

BlockType

Integer

1

防护资源的黑洞状态。

  • 0:未黑洞
  • 1:全部线路黑洞
  • 2:部分线路黑洞
CidrString10.249.206.**/30当 EIP 绑定互联网通道资源,即 BindType=InternetTunnel 时,该参数返回对应的 IP 地址段信息,否则为空。
EipIdStringeip-3refg7ooi4fls5zsk2ibd****资源实例所属 EIP 资源的 ID。
EipNameStringWAFnyqhgLyW资源实例的名称。
IpString10.249.206.**EIP 资源的 IP 地址。

IpVersion

Integer

4

IP 地址格式。

  • 4:IPv4
  • 6:IPv6
GroupNameStringgroup-123防护资源所属规则组的名称。

GroupType

String

customized

规则组的类型,用于标识防护资源所属规则组的分类。

  • default:默认规则组
  • expert:专家规则组
  • customized:自定义规则组

请求示例

GET https://origin_defence.{region}.volcengineapi.com/?Action=DescResourceList&Version=2022-01-01&InsId=43&CurrPage=1&PageSize=10&SearchIp=10.249.206.**&SearchEipId=eip-3refg7ooi4fls5zsk2ibd****&SearchEipName=WAFnyqhgLyW&Status=normal&EipInsTypes=EcsInstance

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescResourceList",
        "Version": "2022-01-01",
        "Service": "origin_defence",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageInfo": {
            "Count": 10,
            "CurrentPage": 1,
            "PageSize": 20,
            "TotalCount": 15
        },
        "Result": {
            "BlockReleaseRemain": 5,
            "IpList": [
                {
                    "AttackStatus": "normal",
                    "BindId": "WAF7346002284446138412",
                    "BindStatus": "used",
                    "BindType": "EcsInstance",
                    "BlockEnd": 1718697249,
                    "BlockType": 1,
                    "Cidr": "10.249.206.**/30",
                    "EipId": "eip-3refg7ooi4fls5zsk2ibd****",
                    "EipName": "WAFnyqhgLyW",
                    "GroupName": "group-123",
                    "GroupType": "customized",
                    "Ip": "10.249.206.**",
                    "IpVersion": 4
                }
            ],
            "IpReserved": 3,
            "IpTotal": 10,
            "IpUsed": 3
        }
    }
}