All Products
Search
Document Center

Web Application Firewall:DescribeDDoSStatus

Last Updated:Nov 15, 2024

Checks whether DDoS attacks occur on specific domain names protected by a Web Application Firewall (WAF) instance.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:DescribeDDoSStatusget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the WAF instance that you want to query.

Note You can call the DescribeInstanceInfo operation to query the ID of the WAF instance.
waf_v3prepaid_public_cn-***
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-acfm***q
RegionIdstringNo

The region in which the WAF instance is deployed. Valid values:

  • cn-hangzhou: Chinese mainland.
  • ap-southeast-1: outside the Chinese mainland.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

D7861F61-5B61-46CE-A47C-***
DDoSStatusarray<object>

Indicates whether DDoS attacks occur on specific domain names.

DDoSStatusobject
Statusstring

Indicates whether DDoS attacks occur on specific domain names. Valid value:

  • doing: DDoS attacks occur on specific domain names.
doing
EventTypestring

The type of events that are triggered by DDoS attacks. Valid values:

  • defense: traffic scrubbing events.
  • blackhole: blackhole filtering events.
blackhole

Examples

Sample success responses

JSONformat

{
  "RequestId": "D7861F61-5B61-46CE-A47C-***",
  "DDoSStatus": [
    {
      "Status": "doing",
      "EventType": "blackhole"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-15The request parameters of the API has changedView Change Details