查询自定义IPS规则详情
功能介绍
功能说明:自定义IPS规则详情,特性:根据路径输入的IPS ID查看对应的自定义IPS详情
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/ips/custom-rule/{ips_cfw_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ips_cfw_id |
是 |
String |
参数解释: cfw侧自定义IPS规则id 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
object_id |
否 |
String |
参数解释: 防护对象ID,该字段已废弃 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
fw_instance_id |
是 |
String |
参数解释: 防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
CustomerIpsVO object |
参数解释: 自定义IPS规则返回数据 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
action |
Integer |
参数解释: 自定义IPS规则执行动作,仅更新自定义IPS规则场景下需要设置,其他场景无需设置 约束限制: 不涉及 取值范围: 0:只记录日志 1:重置/拦截 默认取值: 不涉及 |
group_id |
String |
参数解释: 防火墙集群id,参数已废弃 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
affected_os |
Integer |
参数解释: 影响操作系统 约束限制: 不涉及 取值范围: 0:ANY 1:Windows 2:Linux 3:FreeBSD 4:Solaris 5:Other Unix 6:网络设备 7:Mac OS 8:IOS 9:Android 10:Others 默认取值: 不涉及 |
attack_type |
Integer |
参数解释: 攻击类型 约束限制: 不涉及 取值范围: 1:访问控制 2:漏洞扫描 3:邮件攻击 4:漏洞攻击 5:Web攻击 6:密码攻击 7:劫持攻击 8:协议异常 9:特洛伊木马 10:蠕虫 11:缓冲区溢出 12:黑客工具 13:间谍软件 14:DDos泛洪 15:应用层DDos攻击 16:其他可疑行为 17:可疑DNS活动 18:网络钓鱼 19:垃圾邮件 20:其他攻击 默认取值: 不涉及 |
config_status |
Integer |
参数解释: 规则状态 约束限制: 不涉及 取值范围: 0:初始化 1:配置中 2:配置成功 3:配置失败 默认取值: 不涉及 |
contents |
Array of IpsContent objects |
参数解释: 匹配IPS攻击的报文内容 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
direction |
Integer |
参数解释: 方向 约束限制: 不涉及 取值范围: 0:客户端到服务端 1:服务端到客户端 默认取值: 不涉及 |
dst_port |
Port object |
参数解释: 端口信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
ips_cfw_id |
String |
参数解释: cfw侧自定义IPS规则id 约束限制: 不涉及 取值范围: 32位UUID 默认取值: 不涉及 |
ips_id |
String |
参数解释: ips规则ID, 可通过调用获取ips规则列表获取,通过data.records.ips_id获取。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
ips_name |
String |
参数解释: ips规则名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
protocol |
Integer |
参数解释: 协议类型 约束限制: 不涉及 取值范围: 1:FTP 2:TELNET 3:SMTP 4:DNS_TCP 5:DNS_UDP 6:DHCP 7:TFTP 8:FINGER 9:HTTP 10:POP3 11:SUNRPC_TCP 12:SUNRPC_UDP 13:NNTP 14:MSRPC_TCP 15:MSRPC_UDP 16:NETBIOS_NAME_TCP 17:NETBIOS_NAME_UDP 18:NETBIOS_SMB 19:NETBIOS_DATAGRAM 20:IMAP4 21:SNMP 22:LDAP 23:MSSQL 24:ORACLE 默认取值: 不涉及 |
severity |
Integer |
参数解释: 严重程度 约束限制: 不涉及 取值范围: 0:致命 1:高危 2:中危 3:低危 默认取值: 不涉及 |
software |
Integer |
参数解释: 影响软件 约束限制: 不涉及 取值范围: 0:ANY 1:ADOBE 2:APACHE 3:APPLE 4:CA 5:CISCO 6:GOOGLE_CHROME 7:HP 8:IBM 9:IE 10:IIS 11:MC_AFEE 12:MEDIA_PLAYER 13:MICROSOFT_NET 14:MICROSOFT_EDGE 15:MICROSOFT_EXCHANGE 16:MICROSOFT_OFFICE 17:MICROSOFT_OUTLOOK 18:MICROSOFT_SHARE_POINT 19:MICROSOFT_WINDOWS 20:MOZILLA 21:MSSQL 22:MYSQL 23:NOVELL 24:ORACLE 25:SAMBA 26:SAMSUNG 27:SAP 28:SCADA 29:SQUID 30:SUN 31:SYMANTEC 32:TREND_MICRO 33:VMWARE 34:WORD_PRESS 35:Others 默认取值: 不涉及 |
src_port |
Port object |
参数解释: 端口信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
content |
String |
参数解释: 内容 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
depth |
Integer |
参数解释: 匹配特征时,截止匹配的位置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
is_hex |
Boolean |
参数解释: 报文内容是否为十六进制 约束限制: 不涉及 取值范围: true: 是十六进制 false: 不是十六进制 默认取值: 不涉及 |
is_ignore |
Boolean |
参数解释: 是否忽略大小写 约束限制: 不涉及 取值范围: true: 忽略 false: 不忽略 默认取值: 不涉及 |
is_uri |
Boolean |
参数解释: 是否匹配URL中跟“内容”一致的字段 约束限制: 不涉及 取值范围: true: 匹配 false: 不匹配 默认取值: 不涉及 |
offset |
Integer |
参数解释: 匹配特征时开始的位置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
relative_position |
Integer |
参数解释: 匹配特征时,指定开始的位置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
port_type |
Integer |
参数解释: 端口操作类型 约束限制: 不涉及 取值范围: -1:Any 0:包含 1:排除 默认取值: 不涉及 |
ports |
String |
参数解释: 端口 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
查询项目ID为3d84b4755b39476997c9f7b5a95c25ed,防火墙ID为d6e0a4d0-8b16-47fe-98b6-e1b0a7a14788,防护对象ID为64b8978e-20c0-4b43-b178-885e3cbb380d,自定义IPS规则id为c059d198-5996-46dd-9ed8-83167e6babe8的IPS规则详情
https://{Endpoint}/v1/3d84b4755b39476997c9f7b5a95c25ed/ips/custom-rule/c059d198-5996-46dd-9ed8-83167e6babe8?fw_instance_id=d6e0a4d0-8b16-47fe-98b6-e1b0a7a14788&object_id=64b8978e-20c0-4b43-b178-885e3cbb380d
响应示例
状态码:200
OK
{ "data" : { "action" : 1, "affected_os" : 0, "attack_type" : 1, "config_status" : 2, "contents" : [ { "content" : "apitest", "depth" : 65535, "is_hex" : false, "is_ignore" : true, "is_uri" : false, "offset" : 0, "relative_position" : 0 } ], "direction" : -1, "dst_port" : { "port_type" : -1 }, "ips_cfw_id" : "c059d198-5996-46dd-9ed8-83167e6babe8", "ips_id" : "350020", "ips_name" : "api验证可删可改", "protocol" : 9, "severity" : 0, "software" : 0, "src_port" : { "port_type" : -1 } } }
状态码:400
Bad Request
{ "error_code" : "CFW.00200003", "error_msg" : "参数错误" }
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 48 |
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 ShowCustomerIpsInfoSolution { 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(); ShowCustomerIpsInfoRequest request = new ShowCustomerIpsInfoRequest(); request.withIpsCfwId("{ips_cfw_id}"); try { ShowCustomerIpsInfoResponse response = client.showCustomerIpsInfo(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 32 |
# 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 = ShowCustomerIpsInfoRequest() request.ips_cfw_id = "{ips_cfw_id}" response = client.show_customer_ips_info(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 38 |
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.ShowCustomerIpsInfoRequest{} request.IpsCfwId = "{ips_cfw_id}" response, err := client.ShowCustomerIpsInfo(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。