All Products
Search
Document Center

Anti-DDoS:DescribeIpDdosThreshold

Last Updated:Nov 13, 2024

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

If one or more assets of the current Alibaba Cloud account are added to an Anti-DDoS Origin instance, you can call the DescribeIpDdosThreshold operation to query the details of the DDoS mitigation threshold or traffic scrubbing threshold for a specific asset. The details include the current traffic scrubbing threshold, maximum 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

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-ddos:DescribeIpDdosThresholdget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DdosRegionIdstringYes

The region ID of the asset.

Note You can call the DescribeRegions operation to query the most recent region list.
cn-hangzhou
DdosTypestringYes

The type of the threshold. Valid values:

  • defense: traffic scrubbing threshold
  • blackhole: DDoS mitigation threshold
defense
InstanceTypestringYes

The type of the asset that is assigned a public IP address. Valid values:

  • ecs: ECS instances.
  • slb: SLB instances.
  • eip: EIPs.
  • ipv6: IPv6 gateways.
  • swas: simple application servers.
  • waf: Web Application Firewall (WAF) instances of the Exclusive edition.
  • ga_basic: Global Accelerator (GA) instances.
ecs
InstanceIdstringYes

The ID of the asset.

Note You can call the DescribeInstanceIpAddress operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.
i-bp1i88rqjza51s****
InternetIpstringYes

The IP address of the asset.

192.0.XX.XX

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

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

025F1688-680B-551A-9A8E-1A0D796315CF
Thresholdobject

An array that consists of the details of the threshold.

DdosTypestring

The type of the threshold. Valid values:

  • defense: traffic scrubbing threshold
  • blackhole: DDoS mitigation threshold
defense
IsAutoboolean

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
MaxBpsinteger

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

7500
ElasticBpsinteger

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
InstanceIdstring

The ID of the instance.

i-bp1i88rqjza51s****
Bpsinteger

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.

7500
Ppsinteger

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

Note This parameter is returned only when the value of the DdosType parameter is defense.
5000000
MaxPpsinteger

The maximum packet scrubbing threshold. Unit: pps.

5000000
InternetIpstring

The IP address of the asset.

192.0.XX.XX

Examples

Sample success responses

JSONformat

{
  "RequestId": "025F1688-680B-551A-9A8E-1A0D796315CF",
  "Threshold": {
    "DdosType": "defense",
    "IsAuto": false,
    "MaxBps": 7500,
    "ElasticBps": 12310,
    "InstanceId": "i-bp1i88rqjza51s****",
    "Bps": 7500,
    "Pps": 5000000,
    "MaxPps": 5000000,
    "InternetIp": "192.0.XX.XX"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history