Queries the details about the assets that are 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.

Usage notes

You can call the DescribeInstance operation to query the details about 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 threshold and traffic scrubbing threshold that are configured for the assets in Anti-DDoS Origin Basic, and whether the assets are associated with Anti-DDoS Origin Basic 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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstance

The operation that you want to perform. Set the value to DescribeInstance.

DdosRegionId String Yes cn-hangzhou

The region ID of the asset to query.

Note You can call the DescribeRegions operation to query the most recent region list.
InstanceType String Yes ecs

The type of the asset to query. Valid values:

  • ecs: ECS instance
  • slb: SLB instance
  • eip: EIP
InstanceName String No launch-advisor-2021****

The name of the asset to query.

DdosStatus String No blackholed

The DDoS mitigation status of the asset to query. 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.
InstanceId String No i-bp1cb6x80tfgocid****

The ID of the asset to query.

InstanceIp String No 121.199.XX.XX

The IP address of the asset to query.

CurrentPage Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
Total Integer 1

The total number of the assets.

RequestId String C728D7E9-9A39-52E0-966B-5C33118BDBB0

The ID of the request.

InstanceList Array of Instance

The list of assets.

Instance
InstanceIp String 121.199.XX.XX

The IP address of the asset.

IsBgppack Boolean false

Indicates whether the asset is associated with an Anti-DDoS Origin Basic instance. Valid values:

  • true: The asset is associated with an Anti-DDoS Origin Basic instance.
  • false: The asset is not associated with an Anti-DDoS Origin Basic instance.
IpVersion String v4

The IP version of the IP address. Valid values:

  • v4: IPv4
  • v6: IPv6
ElasticThreshold Integer 12310

The burstable protection threshold for the asset. Unit: Mbit/s.

BlackholeThreshold Integer 5200

The basic protection threshold for the asset. Unit: Mbit/s.

DefenseBpsThreshold Integer 300

The traffic scrubbing threshold for the asset. Unit: Mbit/s.

InstanceName String launch-advisor-2021****

The name of the asset.

InstanceStatus String normal

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 the asset is in the normal state.
DefensePpsThreshold Integer 70000

The packet scrubbing threshold for the asset. Unit: packets per second (PPS).

InstanceId String i-bp1cb6x80tfgocid****

The ID of the asset.

InstanceType String ecs

The type of the asset. Valid values:

  • ecs: ECS instance
  • slb: SLB instance
  • eip: EIP

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeInstance
&DdosRegionId=cn-hangzhou
&InstanceType=ecs
&CurrentPage=1
&PageSize=10
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceResponse>
    <Total>1</Total>
    <RequestId>C728D7E9-9A39-52E0-966B-5C33118BDBB0</RequestId>
    <InstanceList>
        <InstanceIp>121.199.XX.XX</InstanceIp>
        <IsBgppack>false</IsBgppack>
        <IpVersion>v4</IpVersion>
        <ElasticThreshold>12310</ElasticThreshold>
        <BlackholeThreshold>5200</BlackholeThreshold>
        <DefenseBpsThreshold>300</DefenseBpsThreshold>
        <InstanceName>launch-advisor-2021****</InstanceName>
        <InstanceStatus>normal</InstanceStatus>
        <DefensePpsThreshold>70000</DefensePpsThreshold>
        <InstanceId>i-bp1cb6x80tfgocid****</InstanceId>
        <InstanceType>ecs</InstanceType>
    </InstanceList>
</DescribeInstanceResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Total" : 1,
  "RequestId" : "C728D7E9-9A39-52E0-966B-5C33118BDBB0",
  "InstanceList" : [ {
    "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

For a list of error codes, visit the API Error Center.