文档

DescribeInstance - 查询ECS、SLB、EIP资产信息

更新时间:

查询当前阿里云账号拥有的公网IP资产(云服务器ECS实例、负载均衡SLB实例、弹性公网IP实例)的实例详情,该接口已经过时,推荐使用新接口DescribeInstanceIpAddress。

接口说明

本接口用于分页查询当前阿里云账号拥有的公网 IP 资产(云服务器 ECS 实例、负载均衡 SLB 实例、弹性公网 IP 实例)的实例详情,例如,实例的 ID、IP 地址、DDoS 基础防护阈值、流量清洗阈值、是否绑定了 DDoS 原生防护等。

QPS 限制

本接口的单用户 QPS 限制为 200 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DdosRegionIdstring

要查询的公网 IP 资产所在地域 ID。

说明 您可以调用 DescribeRegions 查询所有地域 ID。
cn-hangzhou
InstanceTypestring

要查询的公网 IP 资产的实例类型。取值:

  • ecs:表示查询云服务器 ECS 实例。
  • slb:表示查询负载均衡 SLB 实例。
  • eip:表示查询弹性公网 IP 实例。
ecs
InstanceNamestring

要查询的公网 IP 资产的实例名称。

launch-advisor-2022****
DdosStatusstring

要查询的公网 IP 资产的 DDoS 防护状态。取值:

  • mitigating:表示清洗中,即查询正在进行流量清洗的公网 IP 资产。
  • blackholed:表示黑洞中,即查询处于黑洞状态的公网 IP 资产。
  • normal:表示正常,即查询未遭受 DDoS 攻击的公网 IP 资产。
blackholed
InstanceIdstring

要查询的公网 IP 资产的实例 ID。根据实例类型(InstanceType)不同,此处设置的实例 ID 格式不同,具体说明如下:

  • InstanceTypeecs,在此处设置 ECS 实例 ID,例如,i-bp1cb6x80tfgocid****。
  • InstanceTypeslb,在此处设置 SLB 实例 ID,例如,alb-vn2dqg3v31y2vd****。
  • InstanceTypeeip,在此处设置 SLB 实例 ID,例如,eip-j6ce6dcx9epi7rs46****。
i-bp1cb6x80tfgocid****
InstanceIpstring

要查询的公网 IP 资产的 IP 地址。

121.199.XX.XX
CurrentPageinteger

分页查询时,设置当前页面的页码。默认值为 1

1
PageSizeinteger

分页查询时,设置每页包含公网 IP 资产的数量。默认值为 10

10

返回参数

名称类型描述示例值
object
Totalinteger

查询到的公网 IP 资产的总数量。

1
RequestIdstring

本次请求的 ID。

C728D7E9-9A39-52E0-966B-5C33118BDBB0
InstanceListobject []

公网 IP 资产的实例详情列表。

InstanceIpstring

实例的 IP 地址。

121.199.XX.XX
IsBgppackboolean

实例是否已绑定 DDoS 原生防护。取值:

  • true:表示是。
  • false:表示否。
false
IpVersionstring

实例 IP 地址的协议类型。取值:

  • v4:表示 IPv4 协议。
  • v6:表示 IPv6 协议。
v4
ElasticThresholdinteger

实例的 DDoS 弹性防护阈值。单位:Mbps。

12310
BlackholeThresholdinteger

实例的 DDoS 基础防护阈值。单位:Mbps。

5200
DefenseBpsThresholdinteger

实例的流量清洗阈值。单位:Mbps。

300
InstanceNamestring

实例的名称。

launch-advisor-2021****
InstanceStatusstring

实例的 DDoS 防护状态。取值:

  • mitigating:表示清洗中。
  • blackholed:表示黑洞中。
  • normal:表示正常。
normal
DefensePpsThresholdinteger

实例的报文数量清洗阈值。单位:pps。

70000
InstanceIdstring

实例 ID。

i-bp1cb6x80tfgocid****
InstanceTypestring

实例的类型。取值:

  • ecs:表示云服务器 ECS 实例。
  • slb:表示负载均衡 SLB 实例。
  • eip:表示弹性公网 IP 实例。
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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)