Docs

Web Application Firewall

Domain group management

ListHostGroup

The ListHostGroup API is used to query domain name group information, including details of domain names within the group and associated rule IDs. Supports querying details of the associated domain name group based on domain name, domain name group name, domain name group ID, and more.

HTTP request

Method: POST

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

Request parameters

The following table lists only the request parameters specific to this API and some common parameters. For more information, see Common parameters.

Query

Action String required Sample value: ListHostGroup

API name. The current API name is ListHostGroup.

Version String required Sample value: 2023-12-25

API version. The current API version is 2023-12-25.

Body

ProjectName String Optional Sample value: default

Project name, default is "default". The current resource is associated with the corresponding project, and only projects for which the current identity has permission can be associated. For how to obtain the project name, refer to ListProjectResources - Get project resource list.

HostFix String Optional Sample value: volcwaf.com

Domain name information to query.

HostGroupID Integer Optional Sample value: 7515

Domain name group ID.

ListAll Boolean Optional Sample value: true

Whether to return all domain name groups and their name information. Returned by default.

true: Returned

false: Not returned

NameFix String Optional Sample value: priority protected domain name

Domain name group name to query, supports fuzzy matching.

Page Integer Optional Sample value: 1

Query page number. The default is 1.

PageSize Integer Optional Sample value: 10

Number of items per page, default is 10. Range is 1 ~ 100.

RuleTag String Optional Sample value: F00000000****

Rule ID associated with the domain name group, which can be obtained using the access control query API.

TimeOrderBy String required Sample value: DESC

List display order.

ASC: Sort by update time in ascending order

DESC: Sort by update time in descending order

Response parameters

HostGroupList Object[] Optional Sample value: --

Details of the domain name group list.

Description String Optional Sample value: Used for batch association with the blocklist.

Domain name group description.

HostCount Integer Optional Sample value: 2

Number of domain names contained in the domain name group.

HostGroupId Integer Optional Sample value: 7515

Domain name group ID.

HostList String[] Optional Sample value: ["volcwaf.com","www.testwaf.com"]

Domain names in the domain name group.

Name String Optional Sample value: priority protected domain name

Domain name group name.

RelatedRules Object[] Optional Sample value: --

Associated rule list.

RuleName String Optional Sample value: block_rule

Rule name.

RuleTag String Optional Sample value: F00000000****

Rule ID.

RuleType String Optional Sample value: Block

Rule type.

Allow: Allowlist

Block: Blocklist

UpdateTime String Optional Sample value: 2024-10-25T16:05:57+08:00

Domain name group update time.

PageSize Integer Optional Sample value: 10

Maximum number of items per page.

CurrentPage Integer Optional Sample value: 1

Current page number.

TotalCount Integer Optional Sample value: 15

Total number of rules under the current domain name.

Count Integer Optional Sample value: 5

Current data count.

Error codes

You can visit Common error codes to get more information about error codes.

Sample 1

Request

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

{
    "ProjectName": "default",
    "HostFix": "volcwaf.com",
    "HostGroupID": 7515,
    "ListAll": true,
    "NameFix": "KeyDomainNames",
    "Page": 1,
    "PageSize": 10,
    "RuleTag": "F00000000****",
    "TimeOrderBy": "DESC"
}

Response

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListHostGroup",
        "Version": "2023-12-25",
        "Service": "waf",
        "Region": "cn-beijing"
    },
    "Result": {
        "HostGroupList": [
            {
                "Name": "KeyDomainNames",
                "HostList": [
                    "volcwaf.com",
                    "www.testwaf.com"
                ],
                "HostCount": 2,
                "UpdateTime": "2024-10-25T16:05:57+08:00",
                "Description": "Batch blocklists",
                "HostGroupId": 7515,
                "RelatedRules": [
                    {
                        "RuleTag": "F00000000****",
                        "RuleName": "block_rule",
                        "RuleType": "Block"
                    }
                ]
            }
        ],
        "PageSize": 10,
        "CurrentPage": 1,
        "TotalCount": 15,
        "Count": 5
    }
}

Last updated: 2026.04.22 17:27:29