You need to enable JavaScript to run this app.
导航

获取子域名的解析请求数

最近更新时间2023.12.04 21:06:11

首次发布时间2022.11.24 20:57:31

API 说明

API 名称:ListDomainStatistics
API 域名:open.volcengineapi.com
API 描述:对某个主域名中指定的子域名统计解析请求数。对于最近一个小时内的解析请求数的统计可能会有延时。通常情况下,延时最多是 1 个小时。

请求方法

GET

调用限制

  • 云解析 DNS 免费版无法使用该 API。
  • 每秒最多调用 5 次。

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数API 的名称。该参数的取值是 ListDomainStatistics
VersionString查询参数API 的版本。该参数的取值是 2018-08-01
ZIDInteger查询参数域名的 ID。云解析 DNS 对该域名下的子域名进行统计。

Name

String

查询参数

需要统计请求数的子域名,也可以是子域名包含的关键字。云解析 DNS 根据 NameSearchMode 确定这些子域名,并对每个子域名统计解析请求数。

如果您不指定该参数,则对所有子域名进行统计。

PageSize

Integer

查询参数

每页包含的子域名数量。

系统会将统计的子域名进行分页显示。页数是由被统计子域名的总数和 PageSize 确定。

该参数的默认值是 10,最大值是 500

PageNumberInteger查询参数页码。API 返回该页码所包含的每个子域名的统计数据。该参数的默认值是 1

SearchMode

String

查询参数

Name 的匹配模式。该参数有以下取值:

  • like:表示模糊匹配。

  • exact:表示精确匹配。

该参数的默认值是 like

StartInteger查询参数统计时间段的开始时间。格式是 Unix 时间戳。如果您不指定 StartEnd 参数,统计时间段默认为过去的 3天。这里过去 3 天这个时间段的开始时间是 API 的调用时间。
EndInteger查询参数统计时间段的结束时间。格式是 Unix 时间戳。
ThresholdInteger查询参数请求数的阈值。如果您指定了该参数,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
            }
        ]
    }
}