DescribeDdosThreshold - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the details of the DDoS mitigation thresholds or traffic scrubbing thresholds for specified assets. The assets can be elastic IP addresses (EIPs). The assets can also be Elastic Compute Service (ECS) instances or Server Load Balancer (SLB) instances that are assigned public IP addresses.

Operation description

You can call the DescribeDdosThreshold operation to query the details of the DDoS mitigation thresholds or traffic scrubbing thresholds for specified assets. The details include the current traffic scrubbing threshold, maximum traffic scrubbing threshold, current DDoS mitigation threshold, and maximum DDoS mitigation threshold.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DdosRegionId	string	Yes	The region ID of the asset. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DdosType	string	Yes	The type of the threshold. Valid values: defense: traffic scrubbing threshold blackhole: DDoS mitigation threshold	defense
InstanceType	string	Yes	The type of the asset. Valid values: ecs: ECS instance slb: SLB instance eip: EIP	ecs
InstanceIds	array	Yes	The ID of asset N to query.
	string	Yes	The ID of asset N. The maximum value of N is 200. You can specify up to 200 assets. Separate the IDs of multiple assets with commas (,). Note You can call the DescribeInstance operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.	i-bp10bclrt56fblts****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	E9B3C090-55AD-59C6-979E-FCFD81E7D9E7
Thresholds	object []	An array that consists of the details of the threshold.
DdosType	string	The type of the threshold. Valid values: defense: traffic scrubbing threshold blackhole: DDoS mitigation threshold	defense
IsAuto	boolean	Indicates whether the threshold is automatically adjusted. Valid values: true: The scrubbing thresholds are automatically adjusted based on the traffic load on the asset. false: The scrubbing thresholds are not automatically adjusted. You must manually specify the scrubbing thresholds.	false
MaxBps	integer	The maximum traffic scrubbing threshold. Unit: Mbit/s.	1024
ElasticBps	integer	The burstable protection threshold (the maximum DDoS mitigation threshold). Unit: Mbit/s. Note This parameter is returned only when the value of the DdosType parameter is blackhole.	12310
InstanceId	string	The ID of the instance.	i-bp10bclrt56fblts****
Bps	integer	If the value of the DdosType parameter is defense, the Bps parameter indicates the current traffic scrubbing threshold. Unit: Mbit/s. If the value of the DdosType parameter is blackhole, the Bps parameter indicates the basic protection threshold. Unit: Mbit/s.	500
Pps	integer	The packet scrubbing threshold. Unit: pps. Note This parameter is returned only when the value of the DdosType parameter is defense.	150000
MaxPps	integer	The maximum packet scrubbing threshold. Unit: pps.	150000
InternetIp	string	The IP address of the asset.	192.0.XX.XX

Examples

Sample success responses

JSONformat

{
  "RequestId": "E9B3C090-55AD-59C6-979E-FCFD81E7D9E7",
  "Thresholds": {
    "Threshold": [
      {
        "DdosType": "defense",
        "IsAuto": false,
        "MaxBps": 1024,
        "ElasticBps": 12310,
        "InstanceId": "i-bp10bclrt56fblts****",
        "Bps": 500,
        "Pps": 150000,
        "MaxPps": 150000,
        "InternetIp": "192.0.XX.XX"
      }
    ]
  }
}

Error codes

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