AddHostGroup - 创建域名组--Web应用防火墙-火山引擎

文档中心

立即注册

导航

AddHostGroup - 创建域名组

最近更新时间：2024.11.21 16:17:08首次发布时间：2024.11.21 10:30:47

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

注意事项

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	AddHostGroup	要执行的操作，取值：AddHostGroup。
Version	String	是	2023-12-25	API的版本，取值：2023-12-25。

Body

参数	类型	是否必填	示例值	描述
Description	String	否	用于批量关联禁止访问名单。	域名组描述，用于说明域名组的目的或用途。
HostList	Array of String	是	["volcwaf.com","www.testwaf.com"]	需要添加到该域名组中的域名。待添加的域名必须为已经接入到 WAF 防护实例中的域名，否则无法添加。
Name	String	是	重点防护域名	域名组名称，用于标识该域名组。说明以中文、字母、数字开头。允许字母、数字、中文、点“.”、下划线“_”和中划线“-”。长度为1-128个字符。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
HostGroupId	Integer	7515	域名组 ID，可用于查询、编辑和删除域名组。

请求示例

POST /?Action=AddHostGroup&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T040231Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

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

返回示例

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

错误码

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