根据实例名称和状态查询实例列表。

请求说明

请求方式：GET

请求地址：https://advdefence.volcengineapi.com/?Action=DescInstanceList&Version=2021-06-15

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescInstanceList

要执行的操作，取值：DescInstanceList。

Version string 必选示例值：2021-06-15

API的版本，取值：2021-06-15。

SearchName string 可选示例值：new_ins_1.1.1.1

实例名称，支持模糊匹配。不填写则返回所有实例。

StatusFilter string 可选示例值：running

实例运行状态，不填则返回所有状态的实例信息。

running：运行中

about_to_expire：即将过期

expired：已过期

CurrPage integer 必选示例值：1

当前显示页码，默认为 1。

PageSize integer 必选示例值：20

每个页面可现实的条目数量。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Result object 示例值：--

查询到的实例列表信息。

InsList object[] 示例值：--

实例列表信息。

InsIp string 示例值：1.1.1.1

高防实例 IP 地址。

StopAt integer 示例值：1712225233

实例服务到期时间，秒级时间戳。

StartAt integer 示例值：1712138832

实例服务开始时间，秒级时间戳。

Name string 示例值：new_ins_1.1.1.1

高防实例名称。

HostLimit integer 示例值：60

可防护的域名数量上限。

PortLimit integer 示例值：60

可防护的端口数量上限。

ElaBandStatus integer 示例值：1

弹性防护带宽生效状态，包括以下两种：

1：正常

2：欠费关停

ElaBand integer 示例值：20

弹性防护带宽，单位为 Gbps。

Type integer 示例值：2

实例类型，包括以下三种：

1：试用

2：正式

3：内部分配

AutoRenew boolean 示例值：false

是否自动续费。

true：开启自动续费

false：关闭自动续费

BizBand integer 示例值：100

业务带宽，单位为 Mbps。

AttackCount integer 示例值：10

累计攻击次数。

AttackPeak integer 示例值：0

历史攻击峰值，单位 Kbps。

Id integer 示例值：1125

高防实例 ID。

DefBand integer 示例值：20

基础防护带宽，单位为 Gbps。

ProjectName string 示例值：default

高防实例所属项目的名称，购买实例时可选择，也可以在访问控制的控制台新增项目。默认为 default。

Region string 示例值：ChinaHb

高防实例所在地域，包括以下四种：

ChinaHb：华北

ChinaHn：华南

ChinaHd：华东

ChinaHdNew：华东2

ElaBizBand integer 示例值：100

弹性业务带宽，单位为 Mbps。

ShutdownAt integer 示例值：0

关停转发时间，仅当 status = 2（已过期关停服务）时有值，否则返回为 0。

ElaBizBandSwitch integer 示例值：0

弹性业务带宽开关。

-0：关闭

-1：开启

Status integer 示例值：1

实例防护功能状态：

1：正常

2：已过期关停服务

12：已过期停止转发

StatusName string 示例值：running

实例运行状态名称：

running：运行中

about_to_expired：即将到期

expired：已到期

PortNum integer 示例值：20

当前防护的端口规则数量。

HostNum integer 示例值：6

当前实例防护的域名规则数量。

IpType integer 示例值：4

实例 IP 地址类型，包括以下两种：

4：Ipv4

6：Ipv6

TotalCount integer 示例值：12

查询到的条目总数。

PageInfo object 示例值：--

分页信息。

TotalCount integer 示例值：25

查询到的条目总数。

PageSize integer 示例值：20

每个页面展示的条目数量。

CurrentPage integer 示例值：1

当前展示的页码。

Count integer 示例值：8

当前页面展示的条目数量。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	1	请求内容/参数错误，请检查请求内容/参数格式。	请求体校验失败。请求参数校验失败。
200	2	内部错误，请重试或联系服务提供者。	服务操作失败。
200	10	内部错误，请重试或联系服务提供者。	状态异常。

DDoS防护