DescribeInstanceIpAddress - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the details of the assets within the current Alibaba Cloud account and the details of the Anti-DDoS Origin instance to which the assets belong. 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 DescribeInstanceIpAddress operation to query the DDoS mitigation information and the details of the Anti-DDoS Origin instance. The information and the details include the basic protection threshold and traffic scrubbing threshold for the assets, DDoS mitigation status of the assets, ID of the instance, and the mitigation status of the instance.

Limits

You can call this operation up to 200 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
InstanceType	string	Yes	The type of the asset. Valid values: ecs: ECS instance slb: SLB instance eip: EIP	ecs
InstanceName	string	No	The name of the asset.	launch-advisor-2021****
DdosStatus	string	No	The DDoS mitigation status of the asset. Valid values: defense: queries assets for which traffic scrubbing is performed. blackhole: queries assets for which blackhole filtering is triggered.	normal
InstanceId	string	No	The ID of the instance to which the asset is added.	i-bp1cb6x80tfgocid****
InstanceIp	string	No	The IP address of the asset.	192.0.XX.XX
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
Total	integer	The total number of the assets.	1
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	BC0907F8-A9F3-5E11-977B-D59CD98C64ED
InstanceList	object []	An array that consists of details of the instance.
InstanceId	string	The ID of the instance.	i-bp1cb6x80tfgocid****
InstanceType	string	The type of the asset. Valid values: ecs: ECS instance slb: SLB instance eip: EIP	ecs
InstanceName	string	The name of the instance.	launch-advisor-2021****
InstanceStatus	string	The DDoS mitigation status of the instance. Valid values: normal: normal abnormal: under DDoS attacks	normal
IpAddressConfig	object []	An array that consists of the details of the asset.
InstanceIp	string	The IP address of the asset.	192.0.XX.XX
IsBgppack	boolean	Indicates whether the asset is added to the instance. Valid values: true: yes false: no	true
IpVersion	string	The IP protocol that is supported by the asset. Valid values: v4: IPv4 v6: IPv6	v4
IpStatus	string	The DDoS mitigation status of the asset. Valid values: defense: indicates that traffic scrubbing is performed on the asset. blackhole: indicates that blackhole filtering is triggered for the asset. normal: indicates that no DDoS attacks are launched against the asset.	normal
RegionId	string	The region code of the asset.	cn-hangzhou-dg-a01
ElasticThreshold	integer	The burstable protection threshold for the asset. Unit: Mbit/s.	12310
BlackholeThreshold	integer	The basic protection threshold for the asset. Unit: Mbit/s.	5200
DefenseBpsThreshold	integer	The traffic scrubbing threshold for the asset. Unit: Mbit/s.	300
DefensePpsThreshold	integer	The packet scrubbing threshold for the asset. Unit: packets per second (pps).	70000

Examples

Sample success responses

JSONformat

{
  "Total": 1,
  "RequestId": "BC0907F8-A9F3-5E11-977B-D59CD98C64ED",
  "InstanceList": [
    {
      "InstanceId": "i-bp1cb6x80tfgocid****",
      "InstanceType": "ecs",
      "InstanceName": "launch-advisor-2021****",
      "InstanceStatus": "normal",
      "IpAddressConfig": [
        {
          "InstanceIp": "192.0.XX.XX",
          "IsBgppack": true,
          "IpVersion": "v4",
          "IpStatus": "normal",
          "RegionId": "cn-hangzhou-dg-a01",
          "ElasticThreshold": 12310,
          "BlackholeThreshold": 5200,
          "DefenseBpsThreshold": 300,
          "DefensePpsThreshold": 70000
        }
      ]
    }
  ]
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2023-07-05

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.