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

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDdosThreshold

要执行的操作。取值:DescribeDdosThreshold

DdosRegionId String cn-hangzhou

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

说明 您可以调用DescribeRegions查询所有地域ID。
DdosType String defense

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

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

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

  • ecs:表示查询云服务器ECS实例。
  • slb:表示查询负载均衡SLB实例。
  • eip:表示查询弹性公网IP实例。
InstanceIds.N String i-bp10bclrt56fblts****

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

说明 您可以调用DescribeInstance查询当前阿里云账号拥有的ECS、SLB、EIP实例的ID。

调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用API的请求格式,请参见本文示例中的请求示例。

返回数据

名称 类型 示例值 描述
RequestId String E9B3C090-55AD-59C6-979E-FCFD81E7D9E7

本次请求的ID。

Thresholds Array of Threshold

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

Threshold
DdosType String defense

阈值类型。取值:

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

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

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

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

ElasticBps Integer 12310

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

说明 只有当DdosTypeblackhole(表示查询DDoS防护阈值)时,才会返回该参数。
InstanceId String i-bp10bclrt56fblts****

实例ID。

Bps Integer 500

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

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

Pps Integer 150000

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

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

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDdosThreshold
&DdosRegionId=cn-hangzhou
&DdosType=defense
&InstanceType=ecs
&InstanceIds=["i-bp1cb6x80tfgocid****"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDdosThresholdResponse>
    <RequestId>E9B3C090-55AD-59C6-979E-FCFD81E7D9E7</RequestId>
    <Thresholds>
        <Threshold>
            <Pps>150000</Pps>
            <MaxBps>1024</MaxBps>
            <Bps>500</Bps>
            <InstanceId>i-bp10bclrt56fblts****</InstanceId>
            <DdosType>defense</DdosType>
            <MaxPps>150000</MaxPps>
            <IsAuto>false</IsAuto>
        </Threshold>
    </Thresholds>
</DescribeDdosThresholdResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E9B3C090-55AD-59C6-979E-FCFD81E7D9E7",
  "Thresholds" : {
    "Threshold" : [ {
      "Pps" : 150000,
      "MaxBps" : 1024,
      "Bps" : 500,
      "InstanceId" : "i-bp10bclrt56fblts****",
      "DdosType" : "defense",
      "MaxPps" : 150000,
      "IsAuto" : false
    } ]
  }
}

错误码

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