ListZoneStatisticsByGroup-获取分组的请求量统计--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

ListZoneStatisticsByGroup-获取分组的请求量统计

最近更新时间：2024.11.20 11:13:11首次发布时间：2024.02.02 10:14:51

为指定的主域名、转发规则或 VPC 获取 DNS 查询请求量统计数据。统计数据按流量类型分类，并按解析状态和解析类型分组。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`ListZoneStatisticsByGroup`	API 的名称。该参数的取值是 `ListZoneStatisticsByGroup`。
Version	String	是	`2022-06-01`	表示 API 的版本。该参数的取值是 `2022-06-01`。
ZID	Integer	否	`1234`	主域名的 ID。如果 `TraffcType` 参数被设置为 `Authoritative`，您必须设置 `ZID`。您可以通过 API 获取 ZID 的值：您可以通过以下 API 获取主域名的 ID： CreatePrivateZone API ListPrivateZones API
RuleID	Integer	否	`1234`	转发规则的 ID。如果 `TrafficType` 参数被设置为 `OUTBOUND`，您必须至少设置 `RuleID` 和 `VpcID` 中的一个参数。您可以通过以下 API 获取转发规则的 ID： CreateResolverRule API ListResolverRules API
VpcTrns.N	String	否	`VpcTrns.1="trn:vpc:cn-beijing:12345678:vpc/vpc-3reow******hxad79k"`	域名或转发规则所关联的一个或多个 VPC 的 TRN。格式为 `VpcTrns.N="trn:vpc:region:accountId:vpc/vpcId"`。N 表示 VpcTrns 的序号。N 必须按照从小到大的顺序连续排序。多个 VpcTrns 之间使用 `&` 分隔。单次调用 API 时最多传入 100 个 VpcTrns。如果您需要验证子用户是否对域名关联的 VPC 所在的项目有操作权限，您需要传入该参数。
RuleTrn	String	否	`"trn:private_zone::21******4::rule/rule-1234"`	转发规则的 TRN。格式为 `"trn:private_zone::accountId::rule/ep-ruleId"`。如果您需要验证子用户是否对转发规则所在的项目有操作权限，您需要传入该参数。
TrafficType	String	否	`Cached`	流量类型。默认为全局流量。 Authoritative：权威流量。 Cached：缓存流量。 Recursive：递归流量。 Outbound：转出流量。
VpcID	String	否	`vpc-xxxxx`	与主域名或转发规则关联的 VPC 的 ID。 `VpcID` 参数是否可选取决于 `TraffcType` 参数：如果 `TraffcType` 参数是 `Authoritative` 或 `Outbound`，您必须至少设置 `ZID` 和 `VpcID` 中的一个参数。如果您不设置 `TraffcType` 参数，或 `TraffcType` 参数是 `Cached` 或 `Recursive`，那么您必须设置 `VpcID` 参数。
Region	String	否	`cn-beijing`	VPC 的地域。如果您设置了 `VpcID`，那么您必须设置 `Region` 参数。
Name	String	否	`abc.example.com`	子域名。
Group	String	是	`1`	分组的标准。 1：域名。 2：解析状态。 3：解析记录类型。
PageNumber	Integer	否	`1`	页码。页数由获取的分组总数和 `PageSize` 确定。默认为 1。
PageSize	Integer	否	`10`	每页包含的分组的数量。默认为 10。返回结果会将获取的分组进行分页显示。页数由获取的分组总数和 `PageSize` 确定。
SearchMode	String	否	`LIKE`	查询模式，用于 `Name` 参数。包括以下模式： LIKE（默认）：模糊查询。例如 `%example%`。 EXACT：精确查询。例如 `example`。
Start	Integer	否	`1639548697`	开始时间。格式为 Unix 时间戳，单位为秒。例如 `1639548697`。如果您不设置该参数，开始时间默认为三天前。
End	Integer	否	`1639548697`	结束时间。格式为 Unix 时间戳，单位为秒。例如 `1639548697`。如果您不设置该参数，结束时间默认为当前时间。
SearchOrder	String	否	`desc`	结果的排列顺序。 asc：升序排列。 desc（默认）：降序排列。
OrderKey	String	否	`Count`	结果的排序键。 GroupName：分组名称。 Count（默认）：请求量。

返回参数

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=ListZoneStatisticsByGroup&Version=2022-06-01&ZID=89810&Group=1

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202401232023526B32439380D037E5F671",
        "Action": "ListZoneStatisticsByGroup",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "Total": 4651,
        "Data": [
            {
                "GroupName": "001.example.com.",
                "Count": 56257688,
                "Percent": 0.24396246997026416
            },
            {
                "GroupName": "002.example.com.",
                "Count": 37679707,
                "Percent": 0.1633987231660827
            },
            {
                "GroupName": "003.example.com.",
                "Count": 24965099,
                "Percent": 0.10826159822088977
            },
            {
                "GroupName": "004.example.com.",
                "Count": 15811720,
                "Percent": 0.06856780651345333
            },
            {
                "GroupName": "005.example.com.",
                "Count": 12653122,
                "Percent": 0.05487048980674586
            },
            {
                "GroupName": "006.example.com.",
                "Count": 9855930,
                "Percent": 0.04274041668143251
            },
            {
                "GroupName": "007.example.com.",
                "Count": 6107171,
                "Percent": 0.026483856245403618
            },
            {
                "GroupName": "008.example.com.",
                "Count": 4882023,
                "Percent": 0.021170980036215474
            },
            {
                "GroupName": "009.example.com.",
                "Count": 2583189,
                "Percent": 0.011202045289170374
            },
            {
                "GroupName": "010.example.com.",
                "Count": 2072263,
                "Percent": 0.008986405554170471
            }
        ]
    }
}

错误码

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