文档首页/ 云防火墙 CFW/ API参考/ API/ 访问控制规则管理/ 获取规则的命中次数和最后一次命中时间 - ListAclRuleHitStatus
更新时间:2026-07-07 GMT+08:00
分享

获取规则的命中次数和最后一次命中时间 - ListAclRuleHitStatus

功能介绍

获取规则的命中次数和最后一次命中时间

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/cfw/{fw_instance_id}/acl-rule/hit-info/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

36位UUID

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释

响应的内容类型

约束限制

不涉及

取值范围

application/json

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

rule_ids

Array of strings

参数解释

规则ID,可通过查询防护规则接口查询获得,通过返回值中的data.records.rule_id(.表示各对象之间层级的区分)获得。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

HitStatusResponseData object

参数解释

获取规则的命中次数和最后一次命中时间响应DATA

取值范围

不涉及

表5 HitStatusResponseData

参数

参数类型

描述

records

Array of RuleHitStatusListVO objects

RuleHitStatusListVO

表6 RuleHitStatusListVO

参数

参数类型

描述

rule_id

String

参数解释

规则ID

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

rule_hit_count

Long

参数解释

规则命中次数

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

rule_last_hit_time

Long

参数解释

命中时间

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询项目ID为28f403ddd3f141daa6e046e85cb15519,防护对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e下ACL规则的命中次数和最后一次命中时间

https://{Endpoint}/v1/28f403ddd3f141daa6e046e85cb15519/cfw/bc11e773-35cc-478c-a91c-772ed077e06e/acl-rule/hit-info/batch-query

{
  "rule_ids" : [ "323289bf-252d-4f1b-b579-7f20d850e6cc" ]
}

响应示例

状态码:200

OK

{
  "data" : {
    "records" : [ {
      "rule_id" : "93e4e0f8-45b0-42a3-a3f6-09a10943e823",
      "rule_hit_count" : 1,
      "rule_last_hit_time" : 13516541651
    } ]
  }
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

SDK代码示例

SDK代码示例如下。

查询项目ID为28f403ddd3f141daa6e046e85cb15519,防护对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e下ACL规则的命中次数和最后一次命中时间

 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
52
53
54
55
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.*;

import java.util.List;
import java.util.ArrayList;

public class ListAclRuleHitStatusSolution {

    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();
        ListAclRuleHitStatusRequest request = new ListAclRuleHitStatusRequest();
        request.withFwInstanceId("{fw_instance_id}");
        ListAclRuleHitStatusRequestBody body = new ListAclRuleHitStatusRequestBody();
        List<String> listbodyRuleIds = new ArrayList<>();
        listbodyRuleIds.add("323289bf-252d-4f1b-b579-7f20d850e6cc");
        body.withRuleIds(listbodyRuleIds);
        request.withBody(body);
        try {
            ListAclRuleHitStatusResponse response = client.listAclRuleHitStatus(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());
        }
    }
}

查询项目ID为28f403ddd3f141daa6e046e85cb15519,防护对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e下ACL规则的命中次数和最后一次命中时间

 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
# 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 = ListAclRuleHitStatusRequest()
        request.fw_instance_id = "{fw_instance_id}"
        listRuleIdsbody = [
            "323289bf-252d-4f1b-b579-7f20d850e6cc"
        ]
        request.body = ListAclRuleHitStatusRequestBody(
            rule_ids=listRuleIdsbody
        )
        response = client.list_acl_rule_hit_status(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

查询项目ID为28f403ddd3f141daa6e046e85cb15519,防护对象id为1b90f031-0c7b-4f25-95e2-b6d9940d269e下ACL规则的命中次数和最后一次命中时间

 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
52
53
54
55
56
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := cfw.CfwClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := cfw.NewCfwClient(hcClient)

    request := &model.ListAclRuleHitStatusRequest{}
	request.FwInstanceId = "{fw_instance_id}"
	var listRuleIdsbody = []string{
        "323289bf-252d-4f1b-b579-7f20d850e6cc",
    }
	request.Body = &model.ListAclRuleHitStatusRequestBody{
		RuleIds: listRuleIdsbody,
	}
	response, err := client.ListAclRuleHitStatus(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

相关文档