获取ips规则列表
功能介绍
获取ips规则列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/ips-rule
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,可以从调API处获取,也可以从控制台获取。可通过项目ID获取方式获取 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
affected_application_like |
否 |
Integer |
受影响对象查询关键字,可包含如下:Others、Sun、Apache、IBM、VMware、WordPress、Adobe、Oracle、Google Chrome等 |
create_time |
否 |
Integer |
ips规则创建的年份 |
fw_instance_id |
否 |
String |
防火墙ID,可通过防火墙ID获取方式获取 |
ips_cve_like |
否 |
Integer |
cve id查询关键字,cve id为cve漏洞库中存储的漏洞id |
ips_group |
否 |
Integer |
ips组,使用ips规则拦截模式区分,包含,0:观察模式,1:严格模式,2:中等模式,3:宽松模式 |
ips_id |
否 |
String |
ips规则id |
ips_level |
否 |
Integer |
ips严重等级,包含CRITICAL、HIGH、MEDIUM、LOW |
ips_name_like |
否 |
String |
ips规则名称查询关键字 |
ips_rules_type_like |
否 |
Integer |
ips规则类型,包括漏洞扫描、黑客工具、特洛伊木马等 |
ips_status |
否 |
String |
ips规则状态,包含观察:OBSERVE、拦截:ENABLE、禁用:CLOSE、恢复默认:DEFAULT、全局恢复默认:ALL_DEFAULT |
is_updated_ips_rule_queried |
否 |
Boolean |
是否查询虚拟补丁相对基础防御更新规则,是表示true,否表示false |
limit |
是 |
Integer |
每页显示个数,范围为1-1024 |
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 |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
enterprise_project_id |
否 |
String |
企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,可通过如何获取用户Token获取 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
IpsRuleListVO object |
查询规则列表返回值数据 |
参数 |
参数类型 |
描述 |
---|---|---|
fw_instance_id |
String |
防火墙id |
limit |
Integer |
每页显示个数,范围为1-1024 |
object_id |
String |
防护对象id |
offset |
Integer |
偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 |
records |
Array of IpsRuleVO objects |
查询ips规则列表 |
total |
Integer |
查询ips规则总数 |
参数 |
参数类型 |
描述 |
---|---|---|
affected_application |
String |
受影响对象,可包含如下:Others、Sun、Apache、IBM、VMware、WordPress、Adobe、Oracle、Google Chrome等 |
create_time |
String |
ips规则创建的年份 |
default_status |
String |
默认状态 |
ips_cve |
String |
cve id |
ips_group |
String |
ips组,使用ips规则拦截模式区分,包含,0:观察模式,1:严格模式,2:中等模式,3:宽松模式 |
ips_id |
String |
ips规则id |
ips_level |
String |
ips严重等级, ips严重等级,包含CRITICAL、HIGH、MEDIUM、LOW |
ips_name |
String |
ips规则名称 |
ips_rules_type |
String |
ips规则类型,包括漏洞扫描、黑客工具、特洛伊木马等 |
ips_status |
String |
ips规则状态,包含观察:OBSERVE、拦截:ENABLE、禁用:CLOSE、恢复默认:DEFAULT、全局恢复默认:ALL_DEFAULT |
请求示例
获取项目id为408972e72dcd4c1a9b033e955802a36b的IPS规则列表,防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf,企业项目id为fb55459c-41b3-47fc-885d-540946fddda4,目标对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e。查询结果限制为1000条,偏移量为0。
https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/ips-rule?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4&project_id=408972e72dcd4c1a9b033e955802a36b&object_id=1b90f031-0c7b-4f25-95e2-b6d9940d269e&limit=1000&offset=0
响应示例
状态码:200
查询规则列表返回值
{ "data" : { "fw_instance_id" : "e743cfaf-8164-4807-aa13-d893d83313cf", "limit" : 1000, "offset" : 1, "records" : [ { "affected_application" : "Others", "create_time" : "2015", "default_status" : "CLOSE", "ips_group" : "STRICTLY", "ips_id" : "340710", "ips_level" : "MEDIUM", "ips_name" : "WEBC2-QBP登录响应1 - 嵌入式CnC APT1相关", "ips_rules_type" : "特洛伊木马", "ips_status" : "CLOSE" }, { "affected_application" : "Others", "create_time" : "2015", "default_status" : "CLOSE", "ips_group" : "STRICTLY", "ips_id" : "340922", "ips_level" : "MEDIUM", "ips_name" : "Win32/Fujacks活动", "ips_rules_type" : "特洛伊木马", "ips_status" : "CLOSE" } ], "total" : 2 } }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ListIpsRulesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); ListIpsRulesRequest request = new ListIpsRulesRequest(); try { ListIpsRulesResponse response = client.listIpsRules(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListIpsRulesRequest() response = client.list_ips_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListIpsRulesRequest{} response, err := client.ListIpsRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ListIpsRulesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); ListIpsRulesRequest request = new ListIpsRulesRequest(); try { ListIpsRulesResponse response = client.listIpsRules(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListIpsRulesRequest() response = client.list_ips_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListIpsRulesRequest{} response, err := client.ListIpsRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询规则列表返回值 |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。