You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/云解析 DNS/API 参考/请求量统计接口/ListZoneStatistics-获取主域名的解析请求数
ListZoneStatistics-获取主域名的解析请求数
最近更新时间：2024.06.27 14:33:48首次发布时间：2022.11.24 20:57:31
我的收藏

统计主域名的 DNS 查询请求数。

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

使用说明

  • 请求频率：每秒最多调用 5 次。

请求说明

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

请求参数

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

Query

名称类型是否必选示例值描述
ActionString是ListZoneStatisticsAPI 的名称。该参数的取值是 ListZoneStatistics。
VersionString是2018-08-01API 的版本。该参数的取值是 2018-08-01。
NameString否example.com需要统计请求数的域名，也可以是域名包含的关键字。云解析 DNS 根据 Name 和 SearchMode 确定这些域名，并对每个域名统计 DNS 查询请求数。
PageSizeInteger否10每页包含的域名数量。系统会将统计的域名进行分页显示。页数是由被统计域名的总数和 PageSize 确定。该参数的默认值是 10，最大值是 500。
PageNumberInteger否1页码。API 返回该页码所包含的每个域名的统计数据。该参数的默认值是 1。
SearchModeString否likeName 的匹配模式。该参数有以下取值：
  • like（默认）：表示模糊匹配。
  • exact：表示精确匹配。
StartInteger否1639540000统计时间段的开始时间。格式是 Unix 时间戳（秒）。如果您不指定 Start 参数，统计时间段默认是从您调用 API 的时间开始往前推 3 天。例如，如果您在 2023 年 6 月 8 日 14:00:00 调用该 API，则默认统计时间段为 2023 年 6 月 5 日 14:00:00 至 2023 年 6 月 8 日 14:00:00。
EndInteger否1639550000统计时间段的结束时间。格式是 Unix 时间戳（秒）。如果您不指定 End 参数，统计时间段默认是从 Start 的时间到您调用 API 的时间。
ThresholdInteger否100请求数的阈值。如果您指定了该参数，API 会过滤掉请求数大于该参数的域名。
SearchOrderString否asc请求结果的排序。
  • asc：升序。
  • desc：（默认）降序。
OrderKeyString否Total请求结果排序的键值。
  • ZoneName：（默认）按 ZoneName 参数的值排序。
  • Total：（默认）按 Total 参数的值排序。

返回参数

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=ListZoneStatistics&Threshold=100&Start=1639540000&End=1639550000

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211215192232010225243153052A63E3",
        "Action": "ListZoneStatistics",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "Total": 2,
        "Data": [
            {
                "Timestamp": 0,
                "Success": 1610,
                "NotExists": 0,
                "Error": 0,
                "Total": 1610,
                "Name": "example.com.",
                "ZID": 839,
                "CacheStage": 0
            },
            {
                "Timestamp": 0,
                "Success": 1605,
                "NotExists": 0,
                "Error": 0,
                "Total": 1605,
                "Name": "test.com.",
                "ZID": 841,
                "CacheStage": 0
            }
        ]
    }
}

错误码

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