DescribeRequestData

Last updated: 2021-09-18 16:39:41

1. API Description

Domain name for API request: privatedns.tencentcloudapi.com.

This API is used to get the DNS request volume of a private domain.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeRequestData.
Version Yes String Common parameter. The value used for this API: 2020-10-28.
Region No String Common parameter. This parameter is not required for this API.
TimeRangeBegin Yes String Request volume statistics start time in the format of 2020-11-22 00:00:00
Filters.N No Array of Filter Filter parameter:
TimeRangeEnd No String Request volume statistics end time in the format of 2020-11-22 23:59:59

3. Output Parameters

Parameter Name Type Description
Data Array of MetricData Request volume statistics table
Interval String Request volume unit time. Valid values: Day, Hour
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the DNS request volume of private domain

Input Example

POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRequestData
<Common request parameters>

{
    "Filters": [
        {
            "Name": "Vpc",
            "Values": [
                "vpc-qxxxxx5"
            ]
        }
    ],
    "TimeRangeBegin": "2020-11-22 00:00:00",
    "TimeRangeEnd": "2020-11-23 23:59:59"
}

Output Example

{
  "Response": {
    "RequestId": "e7b6e0f8-df16-afcf-507dea8b6958343d",
    "Data": [
      {
        "Resource": "all",
        "Metric": "request_count",
        "DataSet": [
          {
            "Date": "2020-11-22 00:00:00",
            "Value": 0
          },
          {
            "Date": "2020-11-22 01:00:00",
            "Value": 0
          }
        ]
      }
    ],
    "Interval": "hour"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.UndefiendError Undefined error.
ResourceNotFound.ServiceNotSubscribed The Private DNS service is not activated.
UnauthorizedOperation.UnauthorizedAccount Unverified user.