DescribeWebCcProtectSwitch - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the status of each mitigation policy for a website.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeWebCcProtectSwitch	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.	default
Domains	array	Yes	The domain name of the website. Note A forwarding rule must be configured for the domain name. You can call the DescribeDomains operation to query all domain names.
	string	Yes	The domain name of the website.	www.aliyun**.com

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	3ADD9EED-CA4B-488C-BC82-01B0B899363D
ProtectSwitchList	array<object>	The status of each mitigation policy for the website.
ProtectSwitch	object
BlackWhiteListEnable	integer	The status of Blacklist/Whitelist (Domain Names). Valid values: 0: turned off 1: turned on	1
AiTemplate	string	The level of Intelligent Protection. Valid values: level30: Loose level60: Normal level90: Strict	level60
PreciseRuleEnable	integer	The status of Accurate Access Control. Valid values: 0: turned off 1: turned on	0
Domain	string	The domain name of the website.	www.aliyun.com
AiMode	string	The mode of Intelligent Protection. Valid values: watch: Warning defense: Defense	defense
AiRuleEnable	integer	The status of Intelligent Protection. Valid values: 0: turned off 1: turned on	1
RegionBlockEnable	integer	The status of Location Blacklist (Domain Names). Valid values: 0: turned off 1: turned on	0
CcTemplate	string	The mode of Frequency Control. Valid values: default: Normal gf_under_attack: Emergency gf_sos_verify: Strict gf_sos_enhance: Super Strict	default
CcCustomRuleEnable	integer	The status of the Custom Rules switch for Frequency Control. Valid values: 0: turned off 1: turned on	0
CcEnable	integer	The status of Frequency Control. Valid values: 0: turned off 1: turned on	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "3ADD9EED-CA4B-488C-BC82-01B0B899363D",
  "ProtectSwitchList": [
    {
      "BlackWhiteListEnable": 1,
      "AiTemplate": "level60",
      "PreciseRuleEnable": 0,
      "Domain": "www.aliyun.com",
      "AiMode": "defense",
      "AiRuleEnable": 1,
      "RegionBlockEnable": 0,
      "CcTemplate": "default",
      "CcCustomRuleEnable": 0,
      "CcEnable": 1,
      "CcGlobalSwitch": ""
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.