Documentation|Tencent Cloud

Recent Pages

Documentation

CreateBasicDDoSAlarmThreshold

Last updated: 2020-07-31 10:09:03

1. API Description

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

This API is used to set the DDoS alarm threshold for Anti-DDoS Basic, which is only supported for Anti-DDoS Basic.

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 parameter. The value used for this API: CreateBasicDDoSAlarmThreshold.
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 (`basic`: Anti-DDoS Basic)
Method	Yes	String	`get`: read alarm threshold, `set`: set alarm threshold
AlarmType	No	Integer	Alarm threshold type. 1: inbound traffic, 2: cleansed traffic. This field is required if `Method` is `set`;
AlarmThreshold	No	Integer	Alarm threshold. It is required if `Method` is `set`. If it is set to 0, it means to clear the alarm threshold configuration;

3. Output Parameters

Parameter Name	Type	Description
AlarmThreshold	Integer	If there is an alarm threshold configuration, the returned alarm threshold will be greater than 0; otherwise, the returned alarm threshold will be 0;
AlarmType	Integer	Alarm threshold type. 1: inbound traffic, 2: cleansed traffic. This field is valid if `AlarmThreshold` is above 0;
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Setting DDoS alarm threshold for Anti-DDoS Basic

Input Example

https://dayu.tencentcloudapi.com/?Action=CreateBasicDDoSAlarmThreshold
&Business=bgpip
&Method=set
&AlarmThreshold=1000
&AlarmType=1
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "AlarmThreshold": 1000,
    "AlarmType": 1
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.