tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeBizHttpStatus

Last updated: 2023-05-24 14:57:49

1. API Description

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

This API is used to get the statistics on the status codes of business traffic.

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 Params. The value used for this API: DescribeBizHttpStatus.
Version Yes String Common Params. The value used for this API: 2020-03-09.
Region No String Common Params. This parameter is not required for this API.
Statistics Yes String Statistical mode. Value: sum.
Business Yes String Anti-DDoS service type (bgpip: Anti-DDoS Advanced)
Period Yes Integer Statistical period in seconds. Valid values: 60, 300, 1800, 3600, 21600, and 86400.
StartTime Yes String Statistics start time, such as 2020-02-01 12:04:12
EndTime Yes String Statistics end time, such as 2020-02-03 18:03:23
Id Yes String The resource ID.
Domain No String Specific domain name query
ProtoInfo.N No Array of ProtocolPort Protocol and port list, which is valid when the metric is connum, new_conn or inactive_conn. Valid protocols: TCP, UDP, HTTP, HTTPS

3. Output Parameters

Parameter Name Type Description
HttpStatusMap HttpStatusMap Statistics on the HTTP status codes of business traffic
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the statistical curves on the status codes of business traffic

Input Example

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

{
    "Domain": "xx",
    "Statistics": "xx",
    "Business": "xx",
    "ProtoInfo": [
        {
            "Protocol": "xx",
            "Port": 1
        }
    ],
    "Period": 1,
    "StartTime": "2020-09-22 00:00:00",
    "EndTime": "2020-09-22 00:00:00",
    "Id": "xx"
}

Output Example

{
    "Response": {
        "HttpStatusMap": {
            "SourceHttp2xx": [
                1,
                2,
                3,
                2
            ],
            "Http5xx": [
                1,
                2,
                3,
                2
            ],
            "SourceHttp5xx": [
                1,
                2,
                3,
                2
            ],
            "SourceHttp404": [
                1,
                2,
                3,
                2
            ],
            "Http4xx": [
                1,
                2,
                3,
                2
            ],
            "SourceHttp4xx": [
                1,
                2,
                3,
                2
            ],
            "Http2xx": [
                1,
                2,
                3,
                2
            ],
            "Http404": [
                1,
                2,
                3,
                2
            ],
            "SourceHttp3xx": [
                1,
                2,
                3,
                2
            ],
            "Http3xx": [
                1,
                2,
                3,
                2
            ]
        },
        "RequestId": "xx"
    }
}

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. Please try again later.
InvalidParameter Parameter error.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit should not be exceeded.
MissingParameter Missing parameters. Please check and try again.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist. Please try again later.
ResourceUnavailable The resource is unavailable.
UnknownParameter Unknown parameter error. Please check and try again.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy