文档

DescribeInstanceIpAddress - 查询公网IP资产的DDoS防护信息以及所属原生防护实例的详情

更新时间:

查询当前阿里云账号拥有的公网IP资产(云服务器ECS实例、负载均衡SLB实例、弹性公网IP实例)的DDoS防护信息以及所属原生防护实例的详情。

接口说明

在一个 DDoS 原生防护实例包含一个或者多个公网 IP 资产的场景下,您可以调用 DescribeInstanceIpAddress 接口查询当前阿里云账号拥有的公网 IP 资产的 DDoS 防护信息以及所属原生防护实例的详情,例如 DDoS 基础防护阈值、流量清洗阈值、公网 IP 资产的 DDoS 防护状态、实例 ID、实例的防护状态等。

QPS 限制

本接口的单用户 QPS 限制为 200 次/60 秒。超过限制,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-2021****
DdosStatusstring

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

  • defense:表示清洗中,即查询正在进行流量清洗的公网 IP 资产。
  • blackhole:表示黑洞中,即查询处于黑洞状态的公网 IP 资产。
defense
InstanceIdstring

要查询的公网 IP 资产所属的实例 ID。

i-bp1cb6x80tfgocid****
InstanceIpstring

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

192.0.XX.XX
CurrentPageinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
PageSizeinteger

设置分页查询时,每页显示的公网 IP 资产信息的数量。默认值为 10,表示每页显示 10 条公网 IP 资产信息。

10

返回参数

名称类型描述示例值
object
Totalinteger

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

1
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

BC0907F8-A9F3-5E11-977B-D59CD98C64ED
InstanceListobject []

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

InstanceIdstring

实例 ID。

i-bp1cb6x80tfgocid****
InstanceTypestring

公网 IP 资产的类型。取值:

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

实例的名称。

launch-advisor-2021****
InstanceStatusstring

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

  • normal:表示正常。
  • abnormal:表示被攻击中。
normal
IpAddressConfigobject []

公网 IP 资产的详情列表。

InstanceIpstring

公网 IP 资产的 IP 地址。

192.0.XX.XX
IsBgppackboolean

公网 IP 资产是否已绑定 DDoS 原生防护。取值:

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

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

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

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

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

公网 IP 资产所属的地域编码。

cn-hangzhou-dg-a01
ElasticThresholdinteger

公网 IP 资产的 DDoS 弹性防护阈值。单位:Mbps。

12310
BlackholeThresholdinteger

公网 IP 资产的 DDoS 基础防护阈值。单位:Mbps。

5200
DefenseBpsThresholdinteger

公网 IP 资产的流量清洗阈值。单位:Mbps。

300
DefensePpsThresholdinteger

公网 IP 资产的报文数量清洗阈值。单位:pps。

70000
IsFullProtectioninteger

公网 IP 资产是否在原生防护中全力防护。取值:

  • 0:表示非全力防护。
  • 1:表示全力防护。
0

示例

正常返回示例

JSON格式

{
  "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
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-05OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)