获取自定义ips规则
功能介绍
获取自定义ips规则
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/ips/custom-rule
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，可以从调API处获取，也可以从控制台获取。可通过项目ID获取方式获取 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
action_type |
否 |
Integer |
动作（0：只记录日志，1：重置/拦截） |
|
affected_os |
否 |
Integer |
操作系统 |
|
attack_type |
否 |
Integer |
攻击类型 |
|
fw_instance_id |
是 |
String |
防火墙ID，可通过防火墙ID获取方式获取 |
|
ips_name |
否 |
String |
ips规则名称 |
|
limit |
是 |
Integer |
分页查询数据量限制 |
|
object_id |
是 |
String |
防护对象ID，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为1的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 |
|
offset |
是 |
Integer |
查询偏移量 |
|
protocol |
否 |
Integer |
协议 |
|
severity |
否 |
Integer |
严重程度（critical：致命，high：高危，medium:中危，low:低危） |
|
software |
否 |
Integer |
影响软件 |
|
enterprise_project_id |
否 |
String |
企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token，可通过如何获取用户Token获取 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
PageInfo«CustomerIpsListVO» object |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
limit |
Integer |
|
|
offset |
Integer |
|
|
records |
Array of CustomerIpsListVO objects |
|
|
total |
Integer |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
action |
Integer |
动作（0：只记录日志，1：重置/拦截） |
|
affected_os |
Integer |
操作系统 |
|
attack_type |
Integer |
攻击类型 |
|
config_status |
Integer |
规则状态（0：初始化，1：配置中，2：配置成功，3：配置失败） |
|
content |
String |
内容json存储 |
|
dst_port_type |
Integer |
目的端口类型 |
|
dst_ports |
String |
目的端口 |
|
group_id |
String |
防火墙集群id |
|
ips_cfw_id |
String |
cfw侧自定义ips规则id |
|
ips_id |
String |
山石侧规则id |
|
ips_name |
String |
ips规则名称 |
|
protocol |
Integer |
协议 |
|
severity |
Integer |
严重程度（critical：致命，high：高危，medium:中危，low:低危） |
|
software |
Integer |
影响软件 |
|
src_port_type |
Integer |
源端口类型 |
|
src_ports |
String |
源端口 |
请求示例
获取项目id为eefb11b22d5944f2aa067954516df1cf的自定义IPS规则列表，防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf，企业项目id为fb55459c-41b3-47fc-885d-540946fddda4，目标对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e。查询结果限制为1000条，偏移量为0。
https://{Endpoint}/v1/eefb11b22d5944f2aa067954516df1cf/ips/custom-rule?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4&object_id=1b90f031-0c7b-4f25-95e2-b6d9940d269e&limit=1000&offset=0
响应示例
状态码： 200
OK
{
"data" : {
"limit" : 1000,
"offset" : 0,
"records" : [ ],
"total" : 0
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
