DescribeBizHttpStatus

Last updated: 2021-04-21 15:14:47

1. API Description

Domain name for API request: dayu.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 parameter. The value used for this API: DescribeBizHttpStatus.
Version Yes String Common parameter. The value used for this API: 2018-07-09.
Region No String Common parameter. This parameter is not required for this API.
Business Yes String Anti-DDoS service type (bgpip: Anti-DDoS Advanced)
Id Yes String Resource ID
Period Yes Integer Statistical period in seconds. Valid values: 300, 1800, 3600, 21600, and 86400.
StartTime Yes String Statistics start time
EndTime Yes String Statistics end time
Statistics Yes String Statistical mode, which only supports sum.
ProtoInfo.N No Array of ProtocolPort Protocol and port list, which is valid when the statistical dimension is the number of connections. Valid protocols: TCP, UDP, HTTP, and HTTPS.
Domain No String Specific domain name query

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: dayu.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
      ],
      "So