All Products
Search
Document Center

Anti-DDoS:DescribeBgpPackByIp

Last Updated:Mar 01, 2024

Queries the configurations of the Anti-DDoS Origin Basic instance that is associated with an 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.

Operation description

You can call the DescribeBgpPackByIp operation to query the configurations of the Anti-DDoS Origin instance that is associated with an asset. The configurations include the basic protection threshold, burstable protection threshold, and expiration time.

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DdosRegionIdstringYes

The region ID of the asset to query.

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

The IP address of the asset to query.

Note You can call the DescribeInstance operation to query the IDs of ECS instances, SLB instances, and EIPs within the current Alibaba Cloud account.
118.31.XX.XX

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

E46A08E4-A1CD-5BE9-B580-C4D6E9BC5484
Codeinteger

The HTTP status code of the request.

For more information about status codes, see Common parameters.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true: yes
  • false: no
true
DdosbgpInfoobject

The configurations of the instance that is associated with the asset.

Ipstring

The IP address of the asset.

118.31.XX.XX
ExpireTimelong

The expiration time of the instance. The value is a UNIX timestamp. Unit: milliseconds.

1640448000000
ElasticThresholdinteger

The burstable protection threshold of the instance. Unit: Gbit/s.

301
BaseThresholdinteger

The basic protection threshold of the instance. Unit: Gbit/s.

20
DdosbgpInstanceIdstring

The ID of the instance.

ddosbgp-cn-n6w1r7nz****

Examples

Sample success responses

JSONformat

{
  "RequestId": "E46A08E4-A1CD-5BE9-B580-C4D6E9BC5484",
  "Code": 200,
  "Success": true,
  "DdosbgpInfo": {
    "Ip": "118.31.XX.XX",
    "ExpireTime": 1640448000000,
    "ElasticThreshold": 301,
    "BaseThreshold": 20,
    "DdosbgpInstanceId": "ddosbgp-cn-n6w1r7nz****"
  }
}

Error codes

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