文档中心

Web应用防火墙

域名组管理

AddHostGroup - 创建域名组

域名组是指一组域名的集合，可用于批量关联对应的禁止访问名单或允许访问名单，提高访问管控策略的配置和维护效率。您可以通过 AddHostGroup 接口，将已经接入到 WAF 的域名加入到创建的域名组中，集中创建访问管控策略。

注意事项

创建域名组前，请确保需要添加的防护域名已经接入 WAF 实例。

请求说明

请求方式：POST

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

请求参数

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

Query

Action String 必选示例值：AddHostGroup

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

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

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

Body

ProjectName String 可选示例值：default

项目名称，默认为“default”，当前资源关联对应项目，仅可关联当前身份下具有权限的项目。

项目名称获取方式参考ListProjectResources - 获取项目资源列表。

您也可以调用CreateProject - 创建项目创建新的项目。

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

域名组描述，用于说明域名组的目的或用途。

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

需要添加到该域名组中的域名。待添加的域名必须为已经接入到 WAF 防护实例中的域名，否则无法添加。

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

域名组名称，用于标识该域名组。

说明

以中文、字母、数字开头。

允许字母、数字、中文、点“.”、下划线“_”和中划线“-”。

长度为1~128个字符。

返回参数

HostGroupId Integer 可选示例值：7515

域名组 ID，可用于查询、编辑和删除域名组。

错误码

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

输入示例 1

输入示例

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

{
    "ProjectName": "default",
    "Description": "用于批量关联禁止访问名单。",
    "HostList": [
        "volcwaf.com",
        "www.testwaf.com"
    ],
    "Name": "重点防护域名"
}

输出示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "AddHostGroup",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "HostGroupId": 7515
    }
}

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

这个页面对您有帮助吗？

有用

无用