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.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| yundun-ddos:DescribeInstance | get |
|
| 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 |
| InstanceName | string | No | The name of the asset. | launch-advisor-2022**** |
| DdosStatus | string | No | The DDoS mitigation status of the asset. Valid values:
| blackholed |
| InstanceId | string | No | The ID of the asset. The formats of asset IDs vary based on the value of the InstanceType. parameter.
| 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 parameters
Examples
Sample success responses
JSONformat
{
"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
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|