ModifyDDoSSwitch

Last updated: 2020-07-31 10:08:56

1. API Description

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

This API is used to enable or disable DDoS protection, 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: ModifyDDoSSwitch.
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 DDoS protection status, set: modify DDoS protection status
Ip No String Anti-DDoS Basic IP, which is required only if Business is Anti-DDoS Basic;
BizType No String Product type of IP, which is required only if Business is Anti-DDoS Basic. Valid values: [public (CVM), bm (BM), eni (ENI), vpngw (VPN Gateway), natgw (NAT Gateway), waf (WAF), fpc (finance product), gaap (GAAP), other (hosted IP)]
DeviceType No String Product subtype of IP, which is required only if Business is Anti-DDoS Basic. Valid values: [cvm (CVM), lb (CLB), eni (ENI), vpngw (VPN), natgw (NAT), waf (WAF), fpc (finance), gaap (GAAP), other (hosted IP), eip (BM EIP)]
InstanceId No String Resource instance ID of IP, which is required only if Business is Anti-DDoS Basic. This field is required when binding a new IP. For example, if it is an ENI IP, enter ID(eni-*) of the ENI for InstanceId;
IPRegion No String This field is required only if Business is Anti-DDoS Basic, indicating the IP region. Valid values:
"bj": North China (Beijing)
"cd": Southwest China (Chengdu)
"cq": Southwest China (Chongqing)
"gz": South China (Guangzhou)
"gzopen": South China (Guangzhou Open)
"hk": Hong Kong (China)
"kr": Southeast Asia (Seoul)
"sh": East China (Shanghai)
"shjr": East China (Shanghai Finance)
"szjr": South China (Shenzhen Finance)
"sg": Southeast Asia (Singapore)
"th": Southeast Asia (Thailand)
"de": Europe (Germany)
"usw": West US (Silicon Valley)
"ca": North America (Toronto)
"jp": Japan
"hzec": Hangzhou
"in": India
"use": East US (Virginia)
"ru": Russia
"tpe": Taiwan (China)
"nj": Nanjing
Status No Integer Protection status value, which is optional. Valid values: [0 (disabled), 1 (enabled)]. If Method is get, this field can be left empty;

3. Output Parameters

Parameter Name Type Description
Status Integer Current protection status value. Valid values: [0 (disabled), 1 (enabled)]
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Enabling or disabling DDoS protection

Input Example

https://dayu.tencentcloudapi.com/?Action=ModifyDDoSSwitch
&Business=basic
&Method=set
&Status=0
&Ip=1.1.1.1
&BizType=public
&DeviceType=cvm
&InstanceId=cvm-abdcasddd1
&IPRegion=gz
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "Status": 0
  }
}

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.

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help