调用DescribeInstanceIpAddress获取公网IP资产的DDoS防护信息及所属原生防护实例-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对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-ddos:DescribeInstanceIpAddress

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DdosRegionId	string	是	要查询的公网 IP 资产所在地域 ID。说明您可以调用 DescribeRegions 查询所有地域 ID。	cn-hangzhou
InstanceType	string	是	要查询的公网 IP 资产的实例类型。取值： ecs：表示查询云服务器 ECS 实例。 slb：表示查询负载均衡 SLB 实例。 eip：表示查询弹性公网 IP 实例。 ipv6：表示查询 IPv6 网关公网实例。 swas：表示查询轻量服务器公网实例。 waf：表示查询 Web 应用防火墙独享实例。 ga_basic：表示查询全球加速公网实例。	ecs
InstanceName	string	否	要查询的公网 IP 资产的实例名称。	launch-advisor-2021****
DdosStatus	string	否	要查询的公网 IP 资产的 DDoS 防护状态。取值： defense：表示清洗中，即查询正在进行流量清洗的公网 IP 资产。 blackhole：表示黑洞中，即查询处于黑洞状态的公网 IP 资产。	defense
InstanceId	string	否	要查询的公网 IP 资产所属的实例 ID。	i-bp1cb6x80tfgocid****
InstanceIp	string	否	要查询的公网 IP 资产的 IP 地址。	192.0.XX.XX
CurrentPage	integer	否	设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。	1
PageSize	integer	否	设置分页查询时，每页显示的公网 IP 资产信息的数量。默认值为 10，表示每页显示 10 条公网 IP 资产信息。	10

返回参数

名称	类型	描述	示例值
	object
Total	integer	查询到的公网 IP 资产的总数量。	1
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	BC0907F8-A9F3-5E11-977B-D59CD98C64ED
InstanceList	array<object>	公网 IP 资产所属实例的详情列表。
	array<object>	公网 IP 资产所属实例的详情列表。
InstanceId	string	实例 ID。	i-bp1cb6x80tfgocid****
InstanceType	string	公网 IP 资产的类型。	ecs
InstanceName	string	实例的名称。	launch-advisor-2021****
InstanceStatus	string	实例的 DDoS 防护状态。取值： normal：表示正常。 abnormal：表示被攻击中。	normal
IpAddressConfig	array<object>	公网 IP 资产的详情列表。
	object	公网 IP 资产的详情列表。
InstanceIp	string	公网 IP 资产的 IP 地址。	192.0.XX.XX
IsBgppack	boolean	公网 IP 资产是否已绑定 DDoS 原生防护。取值： true：表示是。 false：表示否。	true
IpVersion	string	IP 地址的协议类型。取值： v4：表示 IPv4 协议。 v6：表示 IPv6 协议。	v4
IpStatus	string	公网 IP 资产的 DDoS 防护状态。取值： mitigating：表示清洗中。 blackholed：表示黑洞中。 normal：表示正常。	normal
RegionId	string	公网 IP 资产所属的地域编码。	cn-hangzhou-dg-a01
ElasticThreshold	integer	公网 IP 资产的 DDoS 弹性防护阈值。单位：Mbps。	12310
BlackholeThreshold	integer	公网 IP 资产的 DDoS 基础防护阈值。单位：Mbps。	5200
DefenseBpsThreshold	integer	公网 IP 资产的流量清洗阈值。单位：Mbps。	300
DefensePpsThreshold	integer	公网 IP 资产的报文数量清洗阈值。单位：pps。	70000
IsFullProtection	integer	公网 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
        }
      ]
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。