DescribeBgpPackByIp - Anti-DDoS - Alibaba Cloud Documentation Center

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-ddos:DescribeBgpPackByIp

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DdosRegionId	string	Yes	The region ID of the asset to query. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
Ip	string	Yes	The IP address of the asset to query. Note You can call the DescribeInstanceIpAddress operation to query the IDs of Elastic Compute Service (ECS) instances, Server Load Balancer (SLB) instances, and elastic IP addresses (EIPs) within the current Alibaba Cloud account.	118.31.XX.XX

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	E46A08E4-A1CD-5BE9-B580-C4D6E9BC5484
Code	integer	The HTTP status code of the request. For more information about status codes, see Common parameters.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: yes false: no	true
DdosbgpInfo	object	The configurations of the instance that is associated with the asset.
Ip	string	The IP address of the asset.	118.31.XX.XX
ExpireTime	integer	The expiration time of the instance. The value is a UNIX timestamp. Unit: milliseconds.	1640448000000
ElasticThreshold	integer	The burstable protection threshold of the instance. Unit: Gbit/s.	301
BaseThreshold	integer	The basic protection threshold of the instance. Unit: Gbit/s.	20
DdosbgpInstanceId	string	The ID of the instance.	ddosbgp-cn-n6w1r7nz****

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.