DescPolicyGroup-查询规则组详情--DDoS防护-火山引擎

文档中心

立即注册

导航

DescPolicyGroup-查询规则组详情

最近更新时间：2025.05.08 11:28:17首次发布时间：2025.05.08 11:28:17

调用 DescPolicyGroup 接口查询规则组详情，包括规则组名称、关联 IP、创建时间、规则组类型等信息。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com/?Action=DescPolicyGroup&Version=2022-01-01

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescPolicyGroup`	接口名称。当前 API 的名称为 `DescPolicyGroup`。
Version	String	是	`2022-01-01`	接口版本。当前 API 的版本为 `2022-01-01`。
CurrPage	Integer	否	`1`	返回页面的页码，需要设置为大于 0 的整数，默认为 1。
PageSize	Integer	否	`10`	每页数量。默认为 10，取值范围：10~100。
ExactMatch	String	否	`true`	是否开启精确匹配，当且仅当传入值为 `true` 时开启精确匹配，其他情况下为模糊匹配。
SearchCommon	String	否	`自定义规则组1`	通用搜索。可通过 IP 地址、实例 ID、规则组名称或规则组备注信息搜索，支持模糊匹配。如果输入多个条件，则仅展示同时满足这些条件的规则。
SearchIns	String	否	`ddos-127cd26b09fa4b00b6905c1d890b****`	通过实例 ID 或者名称搜索，如果同时输入 ID 和名称，则仅展示同时满足两个条件的规则。实例 ID：精确匹配。实例名称：支持模糊匹配。实例 ID 和名称的获取方式可参考DescInstanceList-查询原生防护实例列表。
SearchIp	String	否	`192.1.1.**`	通过规则组关联的 IP 地址筛选，支持模糊匹配。
SearchName	String	否	`自定义规则组1`	通过规则组名称筛选，支持模糊匹配。
SearchNote	String	否	`用于拦截指定IP`	通过规则组备注筛选，支持模糊匹配。
GroupTypeFilter	String	否	`customized`	规则组类型。 default：默认规则组 expert：专家规则组 customized：自定义规则组

返回参数

参数	类型	示例值	描述
TotalCount	Integer	`11`	查询到的符合条件的总数。
PageSize	Integer	`10`	单个页面显示的数量。
CurrentPage	Integer	`1`	当前页面的页码。
Count	Integer	`10`	当前页面中的数量。
PolicyGroups	Array of PolicyGroups	`--`	规则组详情。

PolicyGroups

参数	类型	示例值	描述
AttachedIpList	Array of String	`192.1.1.1,192.2.2.2`	规则组关联的 IP 地址列表。
AttachedIpNum	Integer	`2`	规则组关联的的 IP 地址数量。
CreateTime	String	`2025-04-01T14:29:30+08:00`	规则组创建时间，ISO 8601 格式。
GroupName	String	`自定义规则组1`	规则组名称。
GroupType	String	`customized`	规则组类型。 default：默认规则组 expert：专家规则组 customized：自定义规则组
Note	String	`this is a note`	规则组备注信息。
Status	Integer	`20`	规则组状态： 11：复制中 20：正常
UpdateTime	String	`2025-04-02T16:58:17+08:00`	规则组更新时间，ISO 8601 格式。

请求示例

GET https://open.volcengineapi.com/?Action=DescPolicyGroup&Version=2022-01-01&CurrPage=1&PageSize=10
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240610T082509Z
X-content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240610/cn-beijing/origin_defence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescPolicyGroup",
        "Version": "2022-01-01",
        "Service": "origin_defence",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 2,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 2,
        "PolicyGroups": [
            {
                "GroupName": "默认规则组",
                "GroupType": "default",
                "Note": "",
                "AttachedIpList": [
                    "10.249.143.**",
                    "10.249.143.**"
                ],
                "AttachedIpNum": 2,
                "CreateTime": "2025-02-19T22:05:50+08:00",
                "UpdateTime": "2025-02-19T22:05:50+08:00",
                "Status": 20
            },
            {
                "GroupName": "自定义规则组1",
                "GroupType": "customized",
                "Note": "",
                "AttachedIpList": null,
                "AttachedIpNum": 0,
                "CreateTime": "2025-03-17T15:49:39+08:00",
                "UpdateTime": "2025-03-17T15:49:39+08:00",
                "Status": 20
            }
        ]
    }
}