开启或关闭DDoS防护

最近更新时间:2019-11-22 11:06:45

1. 接口描述

接口请求域名: dayu.tencentcloudapi.com 。

开启或关闭DDoS防护,只支持基础防护产品;

默认接口请求频率限制:10次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyDDoSSwitch
Version String 公共参数,本接口取值:2018-07-09
Region String 公共参数,本接口不需要传递此参数。
Business String 大禹子产品代号(basic表示基础防护)
Method String =get表示读取DDoS防护状态;=set表示修改DDoS防护状态;
Ip String 基础防护的IP,只有当Business为基础防护时才需要填写此字段;
BizType String 只有当Business为基础防护时才需要填写此字段,IP所属的产品类型,取值[public(CVM产品),bm(黑石产品),eni(弹性网卡),vpngw(VPN网关), natgw(NAT网关),waf(Web应用安全产品),fpc(金融产品),gaap(GAAP产品), other(托管IP)]
DeviceType String 只有当Business为基础防护时才需要填写此字段,IP所属的产品子类,取值[cvm(CVM),lb(负载均衡器),eni(弹性网卡),vpngw(VPN),natgw(NAT),waf(WAF),fpc(金融),gaap(GAAP),other(托管IP),eip(黑石弹性IP)]
InstanceId String 只有当Business为基础防护时才需要填写此字段,IP所属的资源实例ID,当绑定新IP时必须填写此字段;例如是弹性网卡的IP,则InstanceId填写弹性网卡的ID(eni-*);
IPRegion String 只有当Business为基础防护时才需要填写此字段,表示IP所属的地域,取值:
"bj": 华北地区(北京)
"cd": 西南地区(成都)
"cq": 西南地区(重庆)
"gz": 华南地区(广州)
"gzopen": 华南地区(广州Open)
"hk": 中国香港
"kr": 东南亚地区(首尔)
"sh": 华东地区(上海)
"shjr": 华东地区(上海金融)
"szjr": 华南地区(深圳金融)
"sg": 东南亚地区(新加坡)
"th": 东南亚地区(泰国)
"de": 欧洲地区(德国)
"usw": 美国西部(硅谷)
"ca": 北美地区(多伦多)
"jp": 日本
"hzec": 杭州
"in": 印度
"use": 美东地区(弗吉尼亚)
"ru": 俄罗斯
"tpe": 中国台湾
"nj": 南京
Status Integer 可选字段,防护状态值,取值[0(关闭),1(开启)];当Method为get时可以不填写此字段;

3. 输出参数

参数名称 类型 描述
Status Integer 当前防护状态值,取值[0(关闭),1(开启)]
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开启或关闭DDoS防护

输入示例

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
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码