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.

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:DescribeInstanceIpAddress

get

*All Resource

*

None

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 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
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.	defense
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 elements

Element	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	array<object>	An array that consists of details of the instance.
	array<object>
InstanceId	string	The ID of the instance.	i-bp1cb6x80tfgocid****
InstanceType	string	The type of the asset. Valid values: ecs slb eip	ecs
InstanceName	string	The name of the instance.	launch-advisor-2021****
InstanceStatus	string	The DDoS mitigation status of the instance. Valid values: normal: not under DDoS attacks. abnormal: under DDoS attacks.	normal
IpAddressConfig	array<object>	An array that consists of the details of the asset.
	object
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 false	true
IpVersion	string	The IP version of the IP address. Valid values: v4: IPv4. v6: IPv6.	v4
IpStatus	string	The DDoS mitigation status of the asset. Valid values: mitigating: indicates that traffic scrubbing is in progress. blackholed: 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 measured in Mbit/s. Unit: Mbit/s.	300
DefensePpsThreshold	integer	The traffic scrubbing threshold for the asset measured in packets per second (PPS). Unit: PPS.	70000
IsFullProtection	integer	Indicates whether best-effort protection is enabled for the asset. Valid values: 0: no. 1: yes.	0

Examples

Success response

JSON format

{
  "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,
          "IsFullProtection": 0
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.