Domain name for API request: dayu.tencentcloudapi.com.
This API is used to get the DDoS protection status (temporarily disabled status). It is supported for Anti-DDoS Basic, single IP instance, multi-IP instance, Anti-DDoS Advanced, and Anti-DDoS Ultimate. It is used to query whether DDoS protection is temporarily disabled, and if yes, return parameters such as temporary disablement duration.
A maximum of 10 requests can be initiated per second for this API.
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: DescribeDDoSDefendStatus. |
| 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, bgp: Anti-DDoS Pro (single IP), bgp-multip: Anti-DDoS (multi-IP), bgpip: Anti-DDoS Advanced, net: Anti-DDoS Ultimate |
| Id | No | String | Instance ID, which is required only if Business is not basic. |
| Ip | No | String | Anti-DDoS Basic IP, which is required only if Business is Anti-DDoS Basic; |
| BizType | No | String | Type of products bound to the anti-DDoS instance, which is required only if Business is Anti-DDoS Basic. Valid values: [public (CVM), bm (Bare metal products), eni (elastic network interface), vpngw (VPN Gateway), natgw (NAT Gateway), waf (Web Application Firewall), fpc (Finance products), 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 |
| Parameter Name | Type | Description |
|---|---|---|
| DefendStatus | Integer | Protection status. 0: disabled, 1: enabled Note: this field may return null, indicating that no valid values can be obtained. |
| UndefendExpire | String | Expiration time of temporary protection disablement. This field is empty if the protection is in enabled status; Note: this field may return null, indicating that no valid values can be obtained. |
| ShowFlag | Integer | Console feature display field. 1: displays console features, 0: hides console features Note: this field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://dayu.tencentcloudapi.com/?Action=DescribeDDoSDefendStatus
&Business=base
&Ip=1.1.1.1
&BizType=public
&.DeviceType=cvm
&InstanceId=ins-f2f9ssbo
&IPRegion=gz
&<Common request parameters>{
"Response": {
"RequestId": "eac6b301-a322-493a-8e36-83b295459397",
"DefendStatus": 0,
"UndefendExpire": "2019-11-14 15:00:00",
"ShowFlag": 1
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?