查询当前阿里云账号拥有的公网IP资产(云服务器ECS实例、负载均衡SLB实例、弹性公网IP实例等)的实例详情,该接口已经过时,推荐使用新接口DescribeInstanceIpAddress。
接口说明
本接口用于分页查询当前阿里云账号拥有的公网 IP 资产(云服务器 ECS 实例、负载均衡 SLB 实例、弹性公网 IP 实例等)的实例详情,例如,实例的 ID、IP 地址、DDoS 基础防护阈值、流量清洗阈值、是否绑定了 DDoS 原生防护等。
QPS 限制
本接口的单用户 QPS 限制为 200 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-ddos:DescribeInstance |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DdosRegionId |
string |
是 |
要查询的公网 IP 资产所在地域 ID。 说明
您可以调用 DescribeRegions 查询所有地域 ID。 |
cn-hangzhou |
| InstanceType |
string |
是 |
要查询的公网 IP 资产的实例类型。取值:
|
ecs |
| InstanceName |
string |
否 |
要查询的公网 IP 资产的实例名称。 |
launch-advisor-2022**** |
| DdosStatus |
string |
否 |
要查询的公网 IP 资产的 DDoS 防护状态。取值:
|
blackholed |
| InstanceId |
string |
否 |
要查询的公网 IP 资产的实例 ID。根据实例类型(InstanceType)不同,此处设置的实例 ID 格式不同,具体说明如下:
|
i-bp1cb6x80tfgocid**** |
| InstanceIp |
string |
否 |
要查询的公网 IP 资产的 IP 地址。 |
121.199.XX.XX |
| CurrentPage |
integer |
否 |
分页查询时,设置当前页面的页码。默认值为 1。 |
1 |
| PageSize |
integer |
否 |
分页查询时,设置每页包含公网 IP 资产的数量。默认值为 10。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Total |
integer |
查询到的公网 IP 资产的总数量。 |
1 |
| RequestId |
string |
本次请求的 ID。 |
C728D7E9-9A39-52E0-966B-5C33118BDBB0 |
| InstanceList |
object |
||
| Instance |
array<object> |
公网 IP 资产的实例详情列表。 |
|
|
object |
公网 IP 资产的实例详情列表。 |
||
| InstanceIp |
string |
实例的 IP 地址。 |
121.199.XX.XX |
| IsBgppack |
boolean |
实例是否已绑定 DDoS 原生防护。取值:
|
false |
| IpVersion |
string |
实例 IP 地址的协议类型。取值:
|
v4 |
| ElasticThreshold |
integer |
实例的 DDoS 弹性防护阈值。单位:Mbps。 |
12310 |
| BlackholeThreshold |
integer |
实例的 DDoS 基础防护阈值。单位:Mbps。 |
5200 |
| DefenseBpsThreshold |
integer |
实例的流量清洗阈值。单位:Mbps。 |
300 |
| InstanceName |
string |
实例的名称。 |
launch-advisor-2021**** |
| InstanceStatus |
string |
实例的 DDoS 防护状态。取值:
|
normal |
| DefensePpsThreshold |
integer |
实例的报文数量清洗阈值。单位:pps。 |
70000 |
| InstanceId |
string |
实例 ID。 |
i-bp1cb6x80tfgocid**** |
| InstanceType |
string |
实例的类型。 |
ecs |
示例
正常返回示例
JSON格式
{
"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"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。