DescribeInstanceIpAddress
Queries the DDoS mitigation information of assets that are assigned public IP addresses (ECS instances, SLB instances, and EIPs) owned by the current Alibaba Cloud account and the details of the associated Anti-DDoS Origin instances.
Operation description
If an Anti-DDoS Origin instance protects one or more assets that are assigned public IP addresses, you can invoke the DescribeInstanceIpAddress operation to query the DDoS mitigation information of the assets that are assigned public IP addresses owned by the current Alibaba Cloud account and the details of the associated Anti-DDoS Origin instance. The information includes the basic Mitigation Threshold, traffic scrubbing threshold, DDoS mitigation status of the assets that are assigned public IP addresses, instance ID, and mitigation status of the instance.
QPS limit
The QPS limit for a single user is 200 calls per 60 seconds. If the limit is exceeded, API calls are throttled, which may affect your services. Call this operation as needed.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-ddos:DescribeInstanceIpAddress |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DdosRegionId |
string |
Yes |
The region ID of the assets that are assigned public IP addresses to query. Note
You can invoke the DescribeRegions operation to query all region IDs. |
cn-hangzhou |
| InstanceType |
string |
Yes |
The instance type of the assets that are assigned public IP addresses to query. Valid values:
|
ecs |
| InstanceName |
string |
No |
The instance name of the assets that are assigned public IP addresses to query. |
launch-advisor-2021**** |
| DdosStatus |
string |
No |
The DDoS mitigation status of the assets that are assigned public IP addresses to query. Valid values:
|
defense |
| InstanceId |
string |
No |
The instance ID of the instance to which the assets that are assigned public IP addresses to query belong. |
i-bp1cb6x80tfgocid**** |
| InstanceIp |
string |
No |
The IP address of the assets that are assigned public IP addresses to query. |
192.0.XX.XX |
| CurrentPage |
integer |
No |
The page number of the returned page. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of entries of assets that are assigned public IP addresses to return on each page. Default value: 10. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Total |
integer |
The total number of returned assets that are assigned public IP addresses. |
1 |
| RequestId |
string |
The request ID. |
BC0907F8-A9F3-5E11-977B-D59CD98C64ED |
| InstanceList |
array<object> |
The details of the instances to which the assets that are assigned public IP addresses belong. |
|
|
array<object> |
The details of the instances to which the assets that are assigned public IP addresses belong. |
||
| InstanceId |
string |
The instance ID. |
i-bp1cb6x80tfgocid**** |
| InstanceType |
string |
The type of the assets that are assigned public IP addresses. |
ecs |
| InstanceName |
string |
The instance name. |
launch-advisor-2021**** |
| InstanceStatus |
string |
The DDoS mitigation status of the instance. Valid values:
|
normal |
| IpAddressConfig |
array<object> |
The details of the assets that are assigned public IP addresses. |
|
|
object |
The details of the assets that are assigned public IP addresses. |
||
| InstanceIp |
string |
The IP address of the assets that are assigned public IP addresses. |
192.0.XX.XX |
| IsBgppack |
boolean |
Indicates whether the asset that is assigned a public IP address is associated with an Anti-DDoS Origin instance. Valid values:
|
true |
| IpVersion |
string |
The protocol type of the IP address. Valid values:
|
v4 |
| IpStatus |
string |
The DDoS mitigation status of the assets that are assigned public IP addresses. Valid values:
|
normal |
| RegionId |
string |
The region ID of the assets that are assigned public IP addresses. |
cn-hangzhou-dg-a01 |
| ElasticThreshold |
integer |
The burstable Mitigation Threshold of the assets that are assigned public IP addresses. Unit: Mbit/s. |
12310 |
| BlackholeThreshold |
integer |
The basic Mitigation Threshold of the assets that are assigned public IP addresses. Unit: Mbit/s. |
5200 |
| DefenseBpsThreshold |
integer |
The traffic scrubbing threshold of the assets that are assigned public IP addresses. Unit: Mbit/s. |
300 |
| DefensePpsThreshold |
integer |
The packet scrubbing threshold of the assets that are assigned public IP addresses. Unit: pps. |
70000 |
| IsFullProtection |
integer |
Indicates whether best-effort protection is enabled for the assets that are assigned public IP addresses in Anti-DDoS Origin. Valid values:
|
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.