DescribeInstance - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the details of the assets within the current Alibaba Cloud account. 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. This operation is phased out. We recommend that you use the DescribeInstanceIpAddress operation.

Operation description

You can call the DescribeInstance operation to query the details of the assets that are within the current Alibaba Cloud account by page. The details include the IDs and IP addresses of the assets, the basic protection thresholds and traffic scrubbing thresholds that are configured for the assets in Anti-DDoS Origin, and whether the assets are associated with Anti-DDoS Origin instances.

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

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 to query. 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-2022****
DdosStatus	string	No	The DDoS mitigation status of the asset. Valid values: mitigating: queries assets for which traffic scrubbing is triggered. blackholed: queries assets for which blackhole filtering is triggered. normal: queries assets that are not under DDoS attacks.	blackholed
InstanceId	string	No	The ID of the asset. The formats of asset IDs vary based on the value of the InstanceType. parameter. If you set InstanceType to ecs, specify the ID of the ECS instance. For example, you can specify i-bp1cb6x80tfgocid**. If you set InstanceType to slb, specify the ID of the SLB instance. For example, you can specify alb-vn2dqg3v31y2vd. If you set InstanceType to eip, specify the ID of the EIP. For example, you can specify eip-j6ce6dcx9epi7rs46**.	i-bp1cb6x80tfgocid****
InstanceIp	string	No	The IP address of the asset.	121.199.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.	C728D7E9-9A39-52E0-966B-5C33118BDBB0
InstanceList	object
Instance	array<object>	The details of the assets.
	object	The details of the asset.
InstanceIp	string	The IP address of the asset.	121.199.XX.XX
IsBgppack	boolean	Indicates whether the asset is associated with an Anti-DDoS Origin Basic instance. Valid values: true: yes false: no	false
IpVersion	string	The IP protocol that is supported by the asset. Valid values: v4: IPv4 v6: IPv6	v4
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
InstanceName	string	The name of the asset.	launch-advisor-2021****
InstanceStatus	string	The DDoS mitigation status of the asset. Valid values: mitigating: indicates that traffic scrubbing is triggered for the asset. blackholed: indicates that blackhole filtering is triggered for the asset. normal: indicates that the instance is normal.	normal
DefensePpsThreshold	integer	The packet scrubbing threshold for the asset. Unit: packets per second (pps).	70000
InstanceId	string	The ID of the asset.	i-bp1cb6x80tfgocid****
InstanceType	string	The type of the asset.	ecs

Examples

Success response

JSON format

{
  "Total": 1,
  "RequestId": "C728D7E9-9A39-52E0-966B-5C33118BDBB0",
  "InstanceList": {
    "Instance": [
      {
        "InstanceIp": "121.199.XX.XX",
        "IsBgppack": false,
        "IpVersion": "v4",
        "ElasticThreshold": 12310,
        "BlackholeThreshold": 5200,
        "DefenseBpsThreshold": 300,
        "InstanceName": "launch-advisor-2021****",
        "InstanceStatus": "normal",
        "DefensePpsThreshold": 70000,
        "InstanceId": "i-bp1cb6x80tfgocid****",
        "InstanceType": "ecs"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.