有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: dnspod.tencentcloudapi.com 。

统计子域名的解析量,帮助您了解流量情况、时间段分布。支持查看近 3 个月内的统计情况。仅付费套餐域名可用。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSubdomainAnalytics。
Version String 公共参数,本接口取值:2021-03-23。
Region String 公共参数,本接口不需要传递此参数。
Domain String 要查询解析量的域名
示例值:example.com
StartDate String 查询的开始时间,格式:YYYY-MM-DD
示例值:2022-06-08
EndDate String 查询的结束时间,格式:YYYY-MM-DD
示例值:2022-06-14
Subdomain String 要查询解析量的子域名
示例值:www
DnsFormat String DATE:按天维度统计 HOUR:按小时维度统计
示例值:DATE
DomainId Integer 域名 ID 。参数 DomainId 优先级比参数 Domain 高,如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId
示例值:1111

3. 输出参数

参数名称 类型 描述
Data Array of DomainAnalyticsDetail 当前统计维度解析量小计
Info SubdomainAnalyticsInfo 子域名解析量统计查询信息
AliasData Array of SubdomainAliasAnalyticsItem 子域名别名解析量统计信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 子域名解析量统计

子域名解析量统计

输入示例

POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSubdomainAnalytics
<公共请求参数>

{
    "Domain": "example.com",
    "StartDate": "2022-06-14",
    "EndDate": "2022-06-14",
    "Subdomain": "test"
}

输出示例

{
    "Response": {
        "AliasData": [],
        "Data": [
            {
                "DateKey": "20221201",
                "HourKey": null,
                "Num": 0
            }
        ],
        "Info": {
            "DnsFormat": "DATE",
            "DnsTotal": 0,
            "Domain": "zhaodapian.com",
            "EndDate": "2022-12-01",
            "StartDate": "2022-12-01",
            "Subdomain": "test"
        },
        "RequestId": "b4aca3e1-c134-4a31-bc07-408d78551449"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DomainIsSpam 封禁域名不能进行此操作。
FailedOperation.DomainNotInService 当前域名还未使用 DNSPod 的解析服务,我们无法获取解析量数据。
FailedOperation.TemporaryError 请求量统计数据暂时不可用,请稍后再试。
FailedOperation.UnknowError 操作未响应,请稍后重试。
InvalidParameter.DomainIdInvalid 域名编号不正确。
InvalidParameter.DomainInvalid 域名不正确,请输入主域名,如 dnspod.cn。
InvalidParameter.DomainIsAliaser 此域名是其它域名的别名。
InvalidParameterValue.DomainGradeInvalid 域名等级不正确。
InvalidParameterValue.DomainNotExists 当前域名有误,请返回重新操作。
OperationDenied.DomainOwnerAllowedOnly 仅域名所有者可进行此操作。