文档中心

Web应用防火墙

域名组管理

ListHostGroup - 查询域名组

ListHostGroup 接口用于查询域名组信息，包括域名组内的域名详情、关联的规则 ID 等信息。支持根据域名、域名组名称域名组 ID 等查询所属域名组详情。

请求说明

请求方式：POST

请求地址：https://waf.volcengineapi.com/?Action=ListHostGroup&Version=2023-12-25

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：ListHostGroup

接口名称。当前 API 的名称为 ListHostGroup。

Version String 必选示例值：2023-12-25

接口版本。当前 API 的版本为 2023-12-25。

Body

ProjectName String 可选示例值：default

项目名称，默认为“default”，当前资源关联对应项目，仅可关联当前身份下具有权限的项目。项目名称获取方式可参考ListProjectResources - 获取项目资源列表。

HostFix String 可选示例值：volcwaf.com

查询的域名信息。

HostGroupID Integer 可选示例值：7515

域名组 ID。

ListAll Boolean 可选示例值：true

是否返回所有域名组及其名称信息，默认返回。

true：返回

false：不返回

NameFix String 可选示例值：重点防护域名

查询的域名组名称，支持模糊匹配。

Page Integer 可选示例值：1

查询页码，默认为 1。

PageSize Integer 可选示例值：10

单页条数，默认为 10。范围为 1 ~ 100。

RuleTag String 可选示例值：F00000000****

域名组关联的规则 ID，可使用访问管控查询接口获取。

TimeOrderBy String 必选示例值：DESC

列表展示时序。

ASC：按更新时间升序

DESC：按更新时间降序

返回参数

HostGroupList Object[] 可选示例值：--

域名组列表详情。

Description String 可选示例值：用于批量关联禁止访问名单。

域名组描述。

HostCount Integer 可选示例值：2

域名组包含的域名数量。

HostGroupId Integer 可选示例值：7515

域名组 ID。

HostList String[] 可选示例值：["volcwaf.com","www.testwaf.com"]

域名组中的域名。

Name String 可选示例值：重点防护域名

域名组名称。

RelatedRules Object[] 可选示例值：--

关联的规则列表。

RuleName String 可选示例值：block_rule

规则名称。

RuleTag String 可选示例值：F00000000****

规则 ID。

RuleType String 可选示例值：Block

规则类型。

Allow：允许访问名单

Block：禁止访问名单

UpdateTime String 可选示例值：2024-10-25T16:05:57+08:00

域名组更新时间。

PageSize Integer 可选示例值：10

每页包含的条数上限。

CurrentPage Integer 可选示例值：1

当前页码。

TotalCount Integer 可选示例值：15

当前域名下的规则总数。

Count Integer 可选示例值：5

当前数据数量。

错误码

您可访问公共错误码，获取更多错误码信息。

输入示例 1

输入示例

POST https://waf.volcengineapi.com/?Action=ListHostGroup&Version=2023-12-25

{
    "ProjectName": "default",
    "HostFix": "volcwaf.com",
    "HostGroupID": 7515,
    "ListAll": true,
    "NameFix": "重点防护域名",
    "Page": 1,
    "PageSize": 10,
    "RuleTag": "F00000000****",
    "TimeOrderBy": "DESC"
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListHostGroup",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "HostGroupList": [
            {
                "Name": "重点防护域名",
                "HostList": [
                    "volcwaf.com",
                    "www.testwaf.com"
                ],
                "HostCount": 2,
                "UpdateTime": "2024-10-25T16:05:57+08:00",
                "Description": "用于批量关联禁止访问名单。",
                "HostGroupId": 7515,
                "RelatedRules": [
                    {
                        "RuleTag": "F00000000****",
                        "RuleName": "block_rule",
                        "RuleType": "Block"
                    }
                ]
            }
        ],
        "PageSize": 10,
        "CurrentPage": 1,
        "TotalCount": 15,
        "Count": 5
    }
}

最近更新时间：2026.01.20 15:17:10

这个页面对您有帮助吗？

有用

无用