tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Web Application Firewall
    Documentation
    Download PDF

    DescribePeakPoints

    Last updated: 2024-11-27 09:46:28
    Download PDF

    1. API Description

    Domain name for API request: waf.intl.tencentcloudapi.com.

    Query business and attack summary trends

    A maximum of 10 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 Params. The value used for this API: DescribePeakPoints.
    Version Yes String Common Params. The value used for this API: 2018-01-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul, ap-shanghai.
    FromTime Yes Timestamp Query start time
    ToTime Yes Timestamp Query End Time
    Domain No String The domain to query, leave this parameter blank if querying data for all domains
    Edition No String Only two values are valid: sparta-waf, clb-waf. No filtering if not input.
    InstanceID No String WAF instance ID. No filter will be carried out if it is not input.
    MetricName No String Twelve available values:
    access: peak QPS trend chart
    botAccess: peak bot QPS trend chart
    down: downstream peak bandwidth trend chart
    up: upstream peak bandwidth trend chart
    attack: trend chart of total web attacks
    cc: trend chart of total CC attacks
    bw: trend chart of total attacks from blocklisted IP addresses
    tamper: trend chart of total tampering attacks
    leak: total leakage trend chart
    acl: trend chart of total access control attacks
    http_status: status code trend chart
    wx_access: trend chart of peak WeChat mini program QPS

    3. Output Parameters

    Parameter Name Type Description
    Points Array of PeakPointsItem Data points
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Input Example

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



{
    "FromTime": "2021-07-21 00:00:00",
    "ToTime": "2021-07-21 23:59:59"
}

    Output Example

    {
    "Response": {
        "Points": [
            {
                "Time": 1626908400,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626908460,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626908520,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626908580,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626908640,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626908700,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626908760,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626908820,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626908880,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626908940,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            },
            {
                "Time": 1626909000,
                "Access": 0,
                "BotAccess": 0,
                "Attack": 0,
                "Cc": 0,
                "Down": 0,
                "Up": 0,
                "StatusServerError": 1,
                "StatusClientError": 1,
                "StatusRedirect": 1,
                "StatusOk": 1,
                "UpstreamServerError": 1,
                "UpstreamClientError": 1,
                "UpstreamRedirect": 1
            }
        ],
        "RequestId": "ead32d5d-a9ac-496f-b8e3-d3a92f1fb1ce"
    }
}

    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
    AuthFailure CAM signature/authentication error.
    FailedOperation Operation failed.
    FailedOperation.CLSInternalError CLS internal error.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.InvalidCertificate Invalid certificate content.
    InvalidParameter.QueryCertBySSLIDFailed Failed to query certificate by ID.
    InvalidParameterValue Invalid parameter value.
    LimitExceeded The quota limit is exceeded.
    MissingParameter Parameters are missing
    OperationDenied Operation denied.
    RequestLimitExceeded Too frequent requests
    ResourceInUse Resources are occupied.
    ResourceInsufficient Insufficient resources.
    ResourceNotFound Resources do not exist.
    ResourceUnavailable Resources are unavailable.
    ResourcesSoldOut Resources are sold out.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter.
    UnsupportedOperation The operation is not supported.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy