Queries the details about the DDoS mitigation threshold or scrubbing thresholds for a specific asset. The asset can be an elastic IP address (EIP). The asset can also be an Elastic Compute Service (ECS) instance or Server Load Balancer (SLB) instance that is assigned a public IP address.

Usage notes

You can call the DescribeDdosThreshold operation to query the details about the DDoS mitigation threshold or scrubbing thresholds for a specific asset. The details include the current scrubbing thresholds, maximum scrubbing thresholds, 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDdosThreshold

The operation that you want to perform. Set the value to DescribeDdosThreshold.

DdosRegionId String Yes cn-hangzhou

The region ID of the asset to query.

Note You can call the DescribeRegions operation to query the most recent region list.
DdosType String Yes defense

The type of the threshold to query. Valid values:

  • defense: scrubbing threshold
  • blackhole: DDoS mitigation threshold
InstanceType String Yes ecs

The type of the asset to query. Valid values:

  • ecs: ECS instance
  • slb: SLB instance
  • eip: EIP
InstanceIds.N String Yes i-bp10bclrt56fblts****

The ID of asset N to query. 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.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String E9B3C090-55AD-59C6-979E-FCFD81E7D9E7

The ID of the request, which is used to locate and troubleshoot issues.

Thresholds Array of Threshold

The details about the thresholds.

Threshold
DdosType String defense

The type of the threshold. Valid values:

  • defense: scrubbing threshold
  • blackhole: DDoS mitigation threshold
IsAuto Boolean false

Indicates whether scrubbing thresholds are 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.
MaxBps Integer 1024

The maximum traffic scrubbing threshold. Unit: Mbit/s.

ElasticBps Integer 12310

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.
InstanceId String i-bp10bclrt56fblts****

The ID of the asset.

Bps Integer 500

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 current basic protection threshold. Unit: Mbit/s.

Pps Integer 150000

The current packet scrubbing threshold. Unit: packets per second (pps).

Note This parameter is returned only when the value of the DdosType parameter is defense.
MaxPps Integer 150000

The maximum packet scrubbing threshold. Unit: pps.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDdosThreshold
&DdosRegionId=cn-hangzhou
&DdosType=defense
&InstanceType=ecs
&InstanceIds=["i-bp10bclrt56fblts****"]
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDdosThresholdResponse>
    <RequestId>E9B3C090-55AD-59C6-979E-FCFD81E7D9E7</RequestId>
    <Thresholds>
        <DdosType>defense</DdosType>
        <IsAuto>false</IsAuto>
        <MaxBps>1024</MaxBps>
        <ElasticBps>12310</ElasticBps>
        <InstanceId>i-bp10bclrt56fblts****</InstanceId>
        <Bps>500</Bps>
        <Pps>150000</Pps>
        <MaxPps>150000</MaxPps>
    </Thresholds>
</DescribeDdosThresholdResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.