文档

DescribeIpDdosThreshold - 查询指定公网IP资产的DDoS防护阈值或流量清洗阈值详情

更新时间:

查询当前阿里云账号下指定公网IP资产(云服务器ECS实例、负载均衡SLB实例、弹性公网IP实例)的DDoS防护阈值或流量清洗阈值详情。

接口说明

在一个 DDoS 原生防护实例包含一个或者多个公网 IP 资产的场景下,您可以调用 DescribeIpDdosThreshold 接口查询指定公网 IP 资产的 DDoS 防护阈值或流量清洗阈值详情,例如当前清洗阈值、最大清洗阈值、当前防护阈值、最大防护阈值等。

QPS 限制

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

调试

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

授权信息

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

请求参数

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

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

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

要查询的阈值类型。取值:

  • defense:表示查询流量清洗阈值。
  • blackhole:表示查询 DDoS 防护阈值。
defense
InstanceTypestring

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

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

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

说明 您可以调用 DescribeInstanceIpAddress 查询当前阿里云账号拥有的 ECS、SLB、EIP 实例的 ID。
i-bp1i88rqjza51s****
InternetIpstring

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

192.0.XX.XX

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

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

025F1688-680B-551A-9A8E-1A0D796315CF
Thresholdobject

公网 IP 资产的阈值详情列表。

DdosTypestring

阈值类型。取值:

  • defense:表示流量清洗阈值。
  • blackhole:表示 DDoS 防护阈值。
defense
IsAutoboolean

是否为系统默认阈值。取值:

  • true:表示是,即由 DDoS 防护服务根据云服务器的流量负载,动态调整清洗阈值。
  • false:表示否,即由您手动设置清洗阈值。
false
MaxBpsinteger

最大流量清洗阈值。单位:Mbps。

7500
ElasticBpsinteger

DDoS 弹性防护阈值(即 DDoS 最大防护阈值)。单位:Mbps。

说明 只有当 DdosTypeblackhole(表示查询 DDoS 防护阈值)时,才会返回该参数。
12310
InstanceIdstring

实例 ID。

i-bp1i88rqjza51s****
Bpsinteger

DdosTypedefense(表示查询流量清洗阈值)时,表示当前流量清洗阈值。单位:Mbps。

DdosTypeblackhole(表示查询 DDoS 防护阈值)时,表示当前 DDoS 基础防护阈值。单位:Mbps。

7500
Ppsinteger

当前报文数量清洗阈值。单位:pps。

说明 只有当 DdosTypedefense(表示查询流量清洗阈值)时,才会返回该参数。
5000000
MaxPpsinteger

最大报文数量清洗阈值。单位:pps。

5000000
InternetIpstring

公网 IP 资产的 IP 地址。

192.0.XX.XX

示例

正常返回示例

JSON格式

{
  "RequestId": "025F1688-680B-551A-9A8E-1A0D796315CF",
  "Threshold": {
    "DdosType": "defense",
    "IsAuto": false,
    "MaxBps": 7500,
    "ElasticBps": 12310,
    "InstanceId": "i-bp1i88rqjza51s****",
    "Bps": 7500,
    "Pps": 5000000,
    "MaxPps": 5000000,
    "InternetIp": "192.0.XX.XX"
  }
}

错误码

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

  • 本页导读 (1)