DescInstanceList-查询原生防护实例列表--DDoS防护-火山引擎

文档中心

立即注册

导航

DescInstanceList-查询原生防护实例列表

最近更新时间：2024.01.26 20:52:21首次发布时间：2023.12.13 17:08:15

查询 DDoS 原生防护实例列表，获取实例 ID、规格、计费状态等信息。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com/?Action=DescInstanceList&Version=2022-01-01

请求参数

以下为该接口的 Query 参数，其他公共参数请参见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	`DescInstanceList`	接口名称。与实际业务的接口名称一致。
Version	String	是	`2022-01-01`	接口的版本。DDoS 原生防护提供的 OpenAPI 版本为`2022-01-01`。
SearchName	String	否	`ddos`	需要查找的实例名称，支持模糊匹配。
CurrPage	Integer	否	`1`	当前页面的页码。例如，`1` 表示展示查询到的第 1 页事件信息。默认为`1`。
PageSize	Integer	否	`10`	单个页面显示的事件数量。默认为`10`。

返回参数

参数	类型	示例值	描述
Result	Result object	-	查询到的实例信息。
PageInfo	PageInfo object	-	页面信息。

Result

参数	类型	示例值	描述
InsList	Array of InsList objects	-	实例列表信息。

InsList

参数	类型	示例值	描述
Id	Integer	`20`	实例 ID。
AttackCount	Integer	`92`	实例所受攻击次数。
AutoRenew	Boolean	`true`	是否开启自动续费。 true：开启。 false：关闭。
DefBand	Integer	`300`	标准防护带宽。单位：Gbps。
ElaBand	Integer	`500`	弹性防护带宽。单位：Gbps。
UsedIpNum	Integer	`2`	已使用防护 IP 数量。
IpNum	Integer	`10`	实例可防护的 IP 总数。
BizBand	Integer	`50`	实例的业务规模。单位：Mbps。
Name	String	`test-addbymanage`	实例名称。
PeakAttackBand	Integer	`3427150`	实例遭受的攻击峰值。单位：Kbps。
Status	Integer	`1`	实例计费状态。 1：运行中。 2：过期关停。 3：过期回收。
StartAt	Integer	`1681943881`	实例开始时间。Unix 秒级时间戳。
StopAt	Integer	`1684511999`	实例到期时间。Unix 秒级时间戳。
Region	String	`cn-beijing`	实例所属地域。 cn-beijing：华北 2（北京） cn-shanghai：华东 2（上海） cn-guangzhou：华南 1（广州）
Spec	String	`Enterprise`	实例套餐规格。 Enterprise：企业版。 Deluxe：高级版。
ElaBandStatus	Integer	`1`	弹性防护带宽生效状态。 1：正常。 2：欠费关停。
IsDemoted	Boolean	`false`	防护能力是否被降级。 true：已降级。 false：未降级。

PageInfo

参数	类型	示例值	描述
TotalCount	Integer	`3`	查询到的符合条件的攻击事件总数。
PageSize	Integer	`10`	单个页面显示的事件数量。
CurrentPage	Integer	`1`	当前页面的页码。例如，`1` 表示展示查询到的第 1 页事件信息。
Count	Integer	`3`	当前页面中包含的事件数量。

请求示例

GET https://open.volcengineapi.com/?Action=DescInstanceList&Version=2022-01-01&SearchName=ddos-test1
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/origin_defence/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202311162124068D795C2273F41FA0****",
        "Action": "DescInstanceList",
        "Version": "2022-01-01",
        "Service": "origin_defence",
        "Region": "cn-beijing"
    },
    "Result": {
        "InsList": [
            {
                "Id": 20,
                "AttackCount": 0,
                "AutoRenew": true,
                "DefBand": 300,
                "ElaBand": 500,
                "UsedIpNum": 2,
                "IpNum": 10,
                "BizBand": 50,
                "Name": "ddos-test1",
                "PeakAttackBand": 0,
                "Status": 1,
                "StartAt": 1681462614,
                "StopAt": 1702569599,
                "Region": "cn-beijing",
                "Spec": "Enterprise",
                "ElaBandStatus": 1,
                "IsDemoted": false
            }
        ]
    },
    "PageInfo": {
        "TotalCount": 2,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 2
    }
}