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

文档中心

立即注册

导航

TrafficRoute DNS 套件

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

最近更新时间：2024.06.27 14:33:48首次发布时间：2022.11.24 20:57:31

对某个主域名的子域名统计 DNS 查询请求数。

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

使用说明

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

请求说明

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

请求参数

除了以下参数，您还需要对请求进行鉴权。

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`ListDomainStatistics`	API 的名称。该参数的取值是 `ListDomainStatistics`。
Version	String	是	`2018-08-01`	API 的版本。该参数的取值是 `2018-08-01`。
ZID	Integer	是	`1234`	主域名的 ID。云解析 DNS 对该主域名下的子域名进行统计。
Name	String	否	`www.example.com`	需要统计请求数的子域名，也可以是子域名包含的关键字。云解析 DNS 根据 `Name` 和 `SearchMode` 确定这些子域名，并对每个子域名统计 DNS 查询请求数。如果您不指定该参数，则对所有子域名进行统计。
PageSize	Integer	否	`10`	每页包含的子域名数量。系统会将统计的子域名进行分页显示。页数是由被统计子域名的总数和 `PageSize` 确定。该参数的默认值是 `10`，最大值是 `500`。
PageNumber	Integer	否	`1`	页码。API 返回该页码所包含的每个子域名的统计数据。该参数的默认值是 `1`。
SearchMode	String	否	`like`	`Name` 的匹配模式。该参数有以下取值： `like`（默认）：模糊匹配。 `exact`：精确匹配。
Start	Integer	否	`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	Integer	否	`1639550000`	统计时间段的结束时间。格式是 Unix 时间戳（秒）。如果您不指定 `End` 参数，统计时间段默认是从 `Start` 的时间到您调用 API 的时间。
Threshold	Integer	否	`100`	请求数的阈值。如果您指定了该参数，API 会过滤掉请求数大于该参数的子域名。

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在区域。

Result 对象

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

示例

请求示例

GET https://open.volcengineapi.com?Version=2018-08-01&Action=ListDomainStatistics&ZID=1376&Threshold=100&Start=1639540000&End=1639550000

返回示例

{
    "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
            }
        ]
    }
}

错误码

您可访问公共错误码，获取详细信息。