获取指定实例下已绑定的防护资源列表信息,包括当前实例支持绑定的资源数量、已经绑定的资源数量和已绑定 EIP 的详细信息。
调用时请将{region}
替换成实际地域 ID,地域详情参见地域信息。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
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 | 否 |
| 按防护资源状态筛选列表,多个类型之间以逗号分隔,值为空时或不传参时为全展示。
|
EipInsTypes | String | 否 |
| 按防护资源绑定的类型筛选列表,多个类型之间以逗号分隔,值为空时或不传参时查询全部资源类型。
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageInfo | Object of PageInfo | -- | 分页信息。 |
Result | Object of Result | -- | 列表详情。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Count | Integer | 10 | 当前页面显示的条目数量。 |
CurrentPage | Integer | 1 | 当前页面的页码。 |
PageSize | Integer | 20 | 单个页面显示的条目数量上限。 |
TotalCount | Integer | 15 | 查询到的符合条件的条目总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
BlockReleaseRemain | Integer | 5 | 当日黑洞解封剩余次数。 |
IpList | Array of IpList | -- | 防护资源的详细信息。 |
IpReserved | Integer | 3 | 预占资源配额数,仅增强型防护 EIP 涉及。创建 ECS 实例时绑定企业版防护资源包,此时需要预占原生防护资源配额,该预占配额数量为需要创建的 ECS 实例数量。更多预占资源的说明,可参考弹性预约实例概述。 |
IpTotal | Integer | 10 | 当前实例下可添加的防护 EIP 总数。 |
IpUsed | Integer | 3 | 当前实例下已添加的防护 EIP 数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AttackStatus | String |
| 防护资源状态。
|
BindId | String | WAF7346002284446138412 | 资源实例的 ID。 |
BindStatus | String |
| 资源与防护实例的绑定状态。
|
BindType | String |
| 防护 EIP 绑定的资源类型。
|
BlockEnd | Integer | 1718697249 | 黑洞预计解封时间,秒级时间戳。 |
BlockType | Integer |
| 防护资源的黑洞状态。
|
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 |
| IP 地址格式。
|
GroupName | String | group-123 | 防护资源所属规则组的名称。 |
GroupType | String |
| 规则组的类型,用于标识防护资源所属规则组的分类。
|
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 } } }