ListHostGroup - 查询域名组--Web应用防火墙-火山引擎

文档中心

立即注册

导航

ListHostGroup - 查询域名组

最近更新时间：2024.11.21 16:17:08首次发布时间：2024.11.20 21:36:57

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
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	否	F000000001193	域名组关联的规则 ID，可使用访问管控查询接口获取。
TimeOrderBy	String	否	DESC	列表展示时序。 ASC：按更新时间升序 DESC：按更新时间降序

返回参数

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

参数	类型	示例值	描述
HostGroupList	Array of Object	--	域名组列表详情。

请求示例

POST /?Action=ListHostGroup&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T084321Z
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

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

返回示例

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

错误码

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