tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Web Application Firewall
    Documentation
    Download PDF

    DescribeHistogram

    Last updated: 2024-09-25 10:12:14
    Download PDF

    1. API Description

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

    Query various conditions of cluster analysis

    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: DescribeHistogram.
    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 Start time
    ToTime Yes Timestamp End time
    QueryField Yes String Clustering fields. ip: IP aggregation; art: response time aggregation; url: URL aggregation; local: city aggregation after IP conversion; qps: second-level peak request count aggregation; up: peak upstream bandwidth aggregation; down: peak downstream bandwidth aggregation
    Source Yes String Condition, access for access logs, attack for attack logs
    Host No String Compatible host, gradually phasing out Host field
    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.
    Domain No String Domain filtering, not applied if not input, used to replace Host field and phase out Host

    3. Output Parameters

    Parameter Name Type Description
    Histogram Array of String Statistical data
    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

    Example1 Querying the Number of Bots

    Input Example

    https://waf.tencentcloudapi.com/?Action=DescribeHistogram
&Host=www.test.com
&FromTime=2019-12-30 00:00:00
&ToTime=2019-12-31 00:00:00
&Edition=clb-waf
&QueryField=ip
&Source=0
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "9ee8be5b-6caa-4c39-ab70-890e0e673515",
        "Histogram": []
    }
}

    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
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Parameters are missing
    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