ListZoneStatistics-获取一个或多个主域名的请求量统计--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

ListZoneStatistics-获取一个或多个主域名的请求量统计

最近更新时间：2024.08.12 11:00:44首次发布时间：2023.02.08 13:13:33

获取一个或多个主域名的请求量统计。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListZoneStatistics?Version=2022-06-01

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`ListZoneStatistics`	API 的名称。该参数的取值是 `ListZoneStatistics`。
Version	String	是	`2022-06-01`	表示 API 的版本。该参数的取值是 `2022-06-01`。
Name	String	否	`example.com`	主域名，例如 `example.com`。如果您将 `SearchMode` 设为 `LIKE`，也可以在该参数中设置主域名的关键字。如果您不传入该参数，则该参数不作为查询条件。
PageNumber	Integer	否	`1`	页码。页数由获取的主域名总数和 `PageSize` 确定。默认为 1。
PageSize	Integer	否	`10`	每页包含的主域名的数量。默认为 10。返回结果会将获取的主域名进行分页显示。页数由获取的主域名总数和 `PageSize` 确定。
SearchMode	String	否	`LIKE`	查询模式，用于 `Name` 参数。包括以下模式： LIKE：（默认）模糊查询。例如 `%example%`。 EXACT：精确查询。例如 `example`。
Start	Integer	否	`1639548697`	开始时间。格式为 Unix 时间戳，单位为秒。如果您不设置该参数，开始时间默认为三天前。
End	Integer	否	`1639548697`	结束时间。格式为 Unix 时间戳，单位为秒。如果您不设置该参数，结束时间默认为当前时间。

返回参数

ResponseMetadata 对象

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

Result 对象

名称	类型	描述
PageNumber	Integer	`Data` 展示的主域名所在的页码。
PageSize	Integer	每页包含的主域名的数量。
Total	Integer	主域名的总数量。
Data	JSON Object	统计数据。

示例

请求示例

GET https://open.volcengineapi.com/?Action=ListZoneStatistics&Version=2022-06-01

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221220173624010208097093247893F4",
        "Action": "ListZoneStatistics",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "Total": 1,
        "Data": [
            {
                "Total": 36127,
                "Name": "private.zone",
                "ZID": 1340
            }
        ]
    }
}

错误码

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