调用DescribeInstanceList查询DDoS原生防护实例的详情。

使用说明

本接口用于分页查询当前阿里云账号拥有的所有DDoS原生防护实例的详情,例如,实例的ID、有效期、状态等。

QPS限制

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

调试

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

请求参数

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

要执行的操作。取值:DescribeInstanceList

ResourceGroupId String rg-acfm2pz25js****

DDoS原生防护实例在资源管理服务中所属的资源组ID。

不设置该参数表示默认资源组。

InstanceIdList String ["ddosbgp-cn-oew1pjrk****"]

要查询的DDoS原生防护实例的ID列表。使用["<实例ID 1>","<实例ID 2>",……]格式表示。

Remark String test

要查询的DDoS原生防护实例的备注。支持模糊查询。

PageNo Integer 1

分页查询时,设置当前页面的页码。

PageSize Integer 10

分页查询时,设置每页包含实例的数量。

IpVersion String IPv4

要查询的DDoS原生防护实例防护的IP资产的协议类型。取值:

  • IPv4:表示IPv4协议。
  • IPv6:表示IPv6协议。
InstanceType String 0

要查询的DDoS原生防护实例的防护套餐类型。取值:

  • 0:表示专业版。
  • 1:表示企业版。
Ip String 47.89.XX.XX

要查询的DDoS原生防护实例的防护对象IP。

Orderby String expireTime

设置DDoS原生防护实例列表的排序字段。取值固定为expireTime,表示按照实例的到期时间排序。

您可以通过Orderdire参数设置排序方式。

Orderdire String desc

设置排序方式。取值:

  • desc(默认):表示按照到期时间降序排序。
  • asc:表示按照到期时间升序排序。
RegionId String cn-hangzhou

要查询的DDoS原生防护实例所在地域ID。

说明 您可以调用DescribeRegions查询DDoS原生防护支持的所有地域ID。
Tag.N.Key String test-key

要查询的DDoS原生防护实例绑定的标签键。

Tag.N.Value String test-value

要查询的DDoS原生防护实例绑定的标签值。

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

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

返回数据

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

查询到的DDoS原生防护实例的总数量。

RequestId String 381D5D33-BB8F-395F-8EE4-AE3BB4B523C4

本次请求的ID。

InstanceList Array of Instance

DDoS原生防护实例的详情列表。

Status String 1

实例的状态。取值:

  • 1:表示正常。
  • 2:表示已过期。
  • 3:表示已释放。
IpType String IPv4

实例防护的IP资产的协议类型。取值:

  • IPv4:表示IPv4协议。
  • IPv6:表示IPv6协议。
AutoRenewal Boolean false

实例是否已开启自动续费。取值:

  • true:表示已开启。
  • false:表示未开启。
Remark String test

实例的备注。

ExpireTime Long 1640275200000

实例的到期时间。使用时间戳表示,单位:毫秒。

Product String gamebox

实例关联的云产品类型。默认不返回该参数,只有当DDoS原生防护实例通过其他云产品创建时,才会返回对应云产品的代码。

取值:

  • gamebox:表示该DDoS原生防护实例通过游戏安全盒服务创建。
  • eip:表示该DDoS原生防护实例通过DDoS防护(增强版)EIP实例创建。
GmtCreate Long 1592886047000

实例的购买时间。使用时间戳表示,单位:毫秒。

InstanceId String ddosbgp-cn-oew1pjrk****

实例ID。

InstanceType String 1

实例的防护套餐类型。取值:

  • 0:表示专业版。
  • 1:表示企业版。
BlackholdingCount String 0

实例防护的公网IP资产中,处于黑洞状态的IP的数量。

说明 您可以调用DeleteBlackhole为单个受保护IP解除黑洞状态。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstanceList
&PageNo=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

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

<DescribeInstanceListResponse>
    <Total>1</Total>
    <RequestId>381D5D33-BB8F-395F-8EE4-AE3BB4B523C4</RequestId>
    <InstanceList>
        <Status>1</Status>
        <IpType>IPv4</IpType>
        <AutoRenewal>false</AutoRenewal>
        <Remark>test</Remark>
        <ExpireTime>1640275200000</ExpireTime>
        <Product>ECS</Product>
        <GmtCreate>1592886047000</GmtCreate>
        <InstanceId>ddosbgp-cn-oew1pjrk****</InstanceId>
        <InstanceType>1</InstanceType>
        <BlackholdingCount>0</BlackholdingCount>
    </InstanceList>
</DescribeInstanceListResponse>

JSON格式

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

{
  "Total" : 1,
  "RequestId" : "381D5D33-BB8F-395F-8EE4-AE3BB4B523C4",
  "InstanceList" : [ {
    "Status" : "1",
    "IpType" : "IPv4",
    "AutoRenewal" : false,
    "Remark" : "test",
    "ExpireTime" : 1640275200000,
    "Product" : "ECS",
    "GmtCreate" : 1592886047000,
    "InstanceId" : "ddosbgp-cn-oew1pjrk****",
    "InstanceType" : "1",
    "BlackholdingCount" : "0"
  } ]
}

错误码

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