ListDomainStatistics - 获取子域名的解析请求数--TrafficRoute DNS 套件-火山引擎

文档中心

TrafficRoute DNS 套件

请求量统计

ListDomainStatistics - 获取子域名的解析请求数

对某个主域名的子域名统计 DNS 查询请求数。
对于最近一个小时内的 DNS 查询请求数的统计可能会有延时。通常情况下，延时最多是 1 个小时。

使用说明

请求频率：每秒最多调用 5 次。
调用限制：该 API 无法统计免费版的主域名。

请求说明

请求方式：GET
请求地址：https://dns.volcengineapi.com/?Action=ListDomainStatistics&Version=2018-08-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListDomainStatistics	要执行的操作，取值：ListDomainStatistics。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
ZID	Long	是	1234	主域名的 ID。云解析 DNS 对该主域名下的子域名进行统计。
PageSize	Integer	否	10	每页包含的子域名数量。系统会将统计的子域名进行分页显示。页数是由被统计子域名的总数和 `PageSize` 确定。该参数的默认值是 `10`，最大值是 `500`。
PageNumber	Integer	否	1	页码。API 返回该页码所包含的每个域名的统计数据。该参数的默认值是 `1`。
SearchMode	String	否	like	`Name` 的匹配模式。该参数有以下取值： `like`（默认）：表示模糊匹配。 `exact`：表示精确匹配。
Start	Long	否	1639540000	统计时间段的开始时间。格式是 Unix 时间戳（秒）。如果您不指定 `Start` 参数，统计时间段默认是从您调用 API 的时间开始往前推 3 天。例如，如果您在 2023 年 6 月 8 日 14:00:00 调用该 API，则默认统计时间段为 2023 年 6 月 5 日 14:00:00 至 2023 年 6 月 8 日 14:00:00。
End	Long	否	1639550000	统计时间段的结束时间。格式是 Unix 时间戳（秒）。如果您不指定 `End` 参数，统计时间段默认是从 `Start` 的时间到您调用 API 的时间。
Threshold	Integer	否	100	请求数的阈值。如果您指定了该参数，API 会过滤掉请求数大于该参数的域名。
Name	String	否	www.example.com	需要统计请求数的子域名，也可以是子域名包含的关键字。云解析 DNS 根据 `Name` 和 `SearchMode` 确定这些子域名，并对每个子域名统计 DNS 查询请求数。如果您不指定该参数，则对所有子域名进行统计。

返回参数

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

参数	类型	示例值	描述
Total	Integer	2	返回的子域名的总数。该参数值不受 `PageNumber` 参数的影响。假设您指定的 `PageNumber` 没有包含任何子域名。此时 `Data` 参数不会展示任何子域名的统计数据。但是 `TotalCount` 仍然会显示该 API 实际统计的子域名总数。
Data	Array of Object	无	子域名的列表。
Page	Integer	1	每个分页所包含的子域名的数量。
Size	Integer	1	`Data` 展示的子域名所在的页码。

请求示例

GET /?Action=ListDomainStatistics&Version=2018-08-01&ZID=1376&Threshold=100&Start=1639540000&End=1639550000  HTTP/1.1
Host: dns.volcengineapi.com
X-Date: 20240908T122410Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240908/cn-beijing/dns/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021121519272101022511001100278B8B",
        "Action": "ListDomainStatistics",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "Page": 1,
        "Size": 10,
        "Total": 1,
        "Data": [
            {
                "Timestamp": 0,
                "Success": 1607,
                "NotExists": 0,
                "Error": 0,
                "Total": 1607,
                "Name": "img.test3.com.",
                "ZID": 0,
                "CacheStage": 0
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
400	ErrZoneNotFound	zone not found	未找到域名。
400	ErrZoneInactive	zone is inactive	域名待找回。
400	ErrPageSizeNotValid	page size must be less than 500 when search	分页查找的记录数量不能大于500。
400	ErrDomainStatisticsNotValid	this zone can't view domain statistics	当前功能版本不支持查看子域名数据统计
400	ErrStatisticsTimeTooLong	statistics time is too long, please reduce the query time range	统计时间过长，请缩小查询时间范围
500	ErrInternalServer	server internal error	服务内部错误。

最近更新时间：2025.06.23 20:22:16

这个页面对您有帮助吗？

有用

无用

TrafficRoute DNS 套件

使用说明 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #