All Products
Search

This Product

    Anti-DDoS:DescribeWebCcProtectSwitch

    Document Center

    Anti-DDoS:DescribeWebCcProtectSwitch

    Last Updated:Dec 14, 2025

    Queries the status of protection features for your web services.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-ddoscoo:DescribeWebCcProtectSwitch

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ResourceGroupId

    string

    No

    The ID of the resource group to which the Anti-DDoS Pro or Anti-DDoS Premium instance belongs in Resource Management. This parameter is empty by default. This means the instance belongs to the default resource group.

    default
    Domains

    array

    Yes

    The domain names of your web services. You can query up to five domain names at a time.

    Note

    The domain names must have forwarding rules configured. You can call DescribeDomains to query all domain names.

    www.aliyun.com

    string

    No

    The domain name of the web service.

    www.aliyun**.com

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    3ADD9EED-CA4B-488C-BC82-01B0B899363D
    ProtectSwitchList

    array<object>

    The status of each protection feature for the web services.

    object

    BlackWhiteListEnable

    integer

    The status of the blacklist and whitelist feature for the domain name. Valid values:

    • 0: Disabled

    • 1: Enabled

    1
    AiTemplate

    string

    The protection level of the AI-powered protection feature. Valid values:

    • level30: Loose

    • level60: Normal

    • level90: Strict

    level60
    PreciseRuleEnable

    integer

    The status of the accurate access control feature. Valid values:

    • 0: Disabled

    • 1: Enabled

    0
    Domain

    string

    The website domain name.

    www.aliyun.com
    AiMode

    string

    The mode of the AI-powered protection feature. Valid values:

    • watch: Warning mode

    • defense: Defense mode

    defense
    AiRuleEnable

    integer

    The status of the AI-powered protection feature. Valid values:

    • 0: Disabled

    • 1: Enabled

    1
    RegionBlockEnable

    integer

    The status of the Location Blacklist feature for the domain name. Valid values:

    • 0: Disabled

    • 1: Enabled

    0
    CcTemplate

    string

    The mode of the Frequency Control (CC protection) feature. 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 Frequency Control (CC protection) feature. Valid values:

    • 0: Disabled

    • 1: Enabled

    0
    CcEnable

    integer

    The status of the Frequency Control (CC protection) feature. Valid values:

    • 0: Disabled

    • 1: Enabled

    1
    CcGlobalSwitch

    string

    Examples

    Success response

    JSON format

    {
  "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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.