调用DescribeInstance查询当前阿里云账号拥有的公网IP资产(云服务器ECS实例、负载均衡SLB实例、弹性公网IP实例)的实例详情。

使用说明

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

QPS限制

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

调试

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

请求参数

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

要执行的操作。取值:DescribeInstance

DdosRegionId String cn-hangzhou

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

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

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

  • ecs:表示查询云服务器ECS实例。
  • slb:表示查询负载均衡SLB实例。
  • eip:表示查询弹性公网IP实例。
InstanceName String launch-advisor-2021****

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

DdosStatus String blackholed

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

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

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

InstanceIp String 121.199.XX.XX

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

CurrentPage Integer 1

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

PageSize Integer 10

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

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

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

返回数据

名称 类型 示例值 描述
Total Integer 1

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

RequestId String C728D7E9-9A39-52E0-966B-5C33118BDBB0

本次请求的ID。

InstanceList Array of Instance

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

Instance
InstanceIp String 121.199.XX.XX

实例的IP地址。

IsBgppack Boolean false

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

  • true:表示是。
  • false:表示否。
IpVersion String v4

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

  • v4:表示IPv4协议。
  • v6:表示IPv6协议。
ElasticThreshold Integer 12310

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

BlackholeThreshold Integer 5200

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

DefenseBpsThreshold Integer 300

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

InstanceName String launch-advisor-2021****

实例的名称。

InstanceStatus String normal

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

  • mitigating:表示清洗中。
  • blackholed:表示黑洞中。
  • normal:表示正常。
DefensePpsThreshold Integer 70000

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

InstanceId String i-bp1cb6x80tfgocid****

实例ID。

InstanceType String ecs

实例的类型。取值:

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstance
&DdosRegionId=cn-hangzhou
&InstanceType=ecs
&CurrentPage=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

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

<DescribeInstanceResponse>
    <Total>1</Total>
    <RequestId>C728D7E9-9A39-52E0-966B-5C33118BDBB0</RequestId>
    <InstanceList>
        <InstanceIp>121.199.XX.XX</InstanceIp>
        <IsBgppack>false</IsBgppack>
        <IpVersion>v4</IpVersion>
        <ElasticThreshold>12310</ElasticThreshold>
        <BlackholeThreshold>5200</BlackholeThreshold>
        <DefenseBpsThreshold>300</DefenseBpsThreshold>
        <InstanceName>launch-advisor-2021****</InstanceName>
        <InstanceStatus>normal</InstanceStatus>
        <DefensePpsThreshold>70000</DefensePpsThreshold>
        <InstanceId>i-bp1cb6x80tfgocid****</InstanceId>
        <InstanceType>ecs</InstanceType>
    </InstanceList>
</DescribeInstanceResponse>

JSON格式

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

{
  "Total" : 1,
  "RequestId" : "C728D7E9-9A39-52E0-966B-5C33118BDBB0",
  "InstanceList" : [ {
    "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"
  } ]
}

错误码

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