文档首页> Web应用防火墙 WAF> API参考> API> 安全总览> 查询安全总览分类统计top信息
更新时间:2024-03-22 GMT+08:00
分享

查询安全总览分类统计top信息

功能介绍

查询安全总览分类统计TOP信息,包含受攻击域名 、攻击源ip、受攻击URL、攻击来源区域、攻击事件分布。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/waf/overviews/classification

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

from

Long

起始时间(13位毫秒时间戳),需要和to同时使用

to

Long

结束时间(13位毫秒时间戳),需要和from同时使用

top

Integer

要查询的前几的结果,最大值为10,默认值为5。

hosts

String

域名id,通过查询云模式防护域名列表(ListHost)获取域名id或者通过独享模式域名列表(ListPremiumHost)获取域名id。默认不传,查询该项目下所有防护域名的top业务异常统计信息。

instances

String

要查询引擎实例id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

Content-Type

String

内容类型

缺省值:application/json;charset=utf8

X-Language

String

语言,默认值为en-us。zh-cn(中文)/en-us(英文)

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

domain

DomainClassificationItem object

受攻击域名

attack_type

AttackTypeClassificationItem object

攻击事件分布

ip

IpClassificationItem object

攻击源ip

url

UrlClassificationItem object

受攻击url

geo

GeoClassificationItem object

攻击来源区域

表5 DomainClassificationItem

参数

参数类型

描述

total

Integer

DomainItem的总数量

items

Array of DomainItem objects

DomainItem详细信息

表6 DomainItem

参数

参数类型

描述

key

String

域名

num

Integer

数量

web_tag

String

网站名称,对应WAF控制台域名详情中的网站名称

表7 AttackTypeClassificationItem

参数

参数类型

描述

total

Integer

AttackTypeItem的总数量

items

Array of AttackTypeItem objects

AttackTypeItem详细信息

表8 AttackTypeItem

参数

参数类型

描述

key

String

攻击事件类型

num

Integer

数量

表9 IpClassificationItem

参数

参数类型

描述

total

Integer

IpItem的总数量

items

Array of IpItem objects

IpItem详细信息

表10 IpItem

参数

参数类型

描述

key

String

ip地址

num

Integer

数量

表11 UrlClassificationItem

参数

参数类型

描述

total

Integer

UrlItem的总数量

items

Array of UrlItem objects

UrlItem详细信息

表12 UrlItem

参数

参数类型

描述

key

String

url路径

num

Integer

数量

host

String

域名

表13 GeoClassificationItem

参数

参数类型

描述

total

Integer

GeoItem的总数量

items

Array of GeoItem objects

GeoItem详细信息

表14 GeoItem

参数

参数类型

描述

key

String

攻击来源区域

num

Integer

数量

状态码: 400

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

查询项目id为project_id,时间从2022-05-19 00:00:00到2022-06-17 11:14:41,域名id为“1bac09440a814aa98ed08302c580a48b”,引擎实例id为“5a532f83a2fb476ba51ca1de7b1ebc43”的top10安全总览分类统计信息

GET https://{Endpoint}/v1/{project_id}/waf/overviews/classification?enterprise_project_id=0&from=1652889600354&to=1655435681354&top=10&hosts=1bac09440a814aa98ed08302c580a48b&instances=5a532f83a2fb476ba51ca1de7b1ebc43

响应示例

状态码: 200

ok

{
  "attack_type" : {
    "total" : 1,
    "items" : [ {
      "key" : "custom_custom",
      "num" : 2
    } ]
  },
  "domain" : {
    "total" : 2,
    "items" : [ {
      "key" : "www.whitelist.com",
      "num" : 2,
      "web_tag" : "www.whitelist.com"
    }, {
      "key" : "zbx002.apayaduo.cn",
      "num" : 2,
      "web_tag" : ""
    } ]
  },
  "geo" : {
    "total" : 1,
    "items" : [ {
      "key" : "上海",
      "num" : 2
    } ]
  },
  "ip" : {
    "total" : 1,
    "items" : [ {
      "key" : "10.142.4.15",
      "num" : 2
    } ]
  },
  "url" : {
    "total" : 1,
    "items" : [ {
      "key" : "/attack",
      "num" : 2,
      "host" : "www.whitelist.com"
    } ]
  }
}

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
49
50
51
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;


public class ListOverviewsClassificationSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        WafClient client = WafClient.newBuilder()
                .withCredential(auth)
                .withRegion(WafRegion.valueOf("<YOUR REGION>"))
                .build();
        ListOverviewsClassificationRequest request = new ListOverviewsClassificationRequest();
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withFrom(<from>L);
        request.withTo(<to>L);
        request.withTop(<top>);
        request.withHosts("<hosts>");
        request.withInstances("<instances>");
        try {
            ListOverviewsClassificationResponse response = client.listOverviewsClassification(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
33
34
35
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = WafClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(WafRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListOverviewsClassificationRequest()
        request.enterprise_project_id = "<enterprise_project_id>"
        request._from = <from>
        request.to = <to>
        request.top = <top>
        request.hosts = "<hosts>"
        request.instances = "<instances>"
        response = client.list_overviews_classification(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
39
40
41
42
43
44
45
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := waf.NewWafClient(
        waf.WafClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListOverviewsClassificationRequest{}
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	request.From = int64(<from>)
	request.To = int64(<to>)
	topRequest:= int32(<top>)
	request.Top = &topRequest
	hostsRequest:= "<hosts>"
	request.Hosts = &hostsRequest
	instancesRequest:= "<instances>"
	request.Instances = &instancesRequest
	response, err := client.ListOverviewsClassification(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

ok

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品