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

文档中心

立即注册

导航

DescInstanceList-查询实例列表

最近更新时间：2024.06.27 22:21:30首次发布时间：2024.06.27 22:21:30

根据实例规格（企业版或高级版）查询对应的实例列表信息，或根据实例名称模糊匹配对应的实例列表。

请求说明

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

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescInstanceList`	接口名称。当前 API 的名称为 `DescInstanceList`。
Version	String	是	`2022-01-01`	接口版本。当前 API 的版本为 `2022-01-01`。
CurrPage	Integer	否	`1`	查询结果展示的页码，即第几页。不填则默认展示第 1 页的查询结果。
PageSize	Integer	否	`10`	每个页面展示的结果数量，可选范围为 10～100 区间内的整数。不填则默认展示 10 个。
SearchName	String	否	`test`	需要查找的实例名称，支持模糊匹配。
Spec	String	否	`Deluxe`	查询的防护实例规格，不填则查询所有规格的实例。 Deluxe：高级版 Enterprise：企业版

返回参数

参数	类型	示例值	描述
PageInfo	Object of PageInfo	`--`	分页信息。
Result	Object of Result	`--`	列表详情。

PageInfo

参数	类型	示例值	描述
Count	Integer	`10`	当前页面显示的条目数量。
CurrentPage	Integer	`1`	当前页面的页码。
PageSize	Integer	`20`	单个页面显示的条目数量上限。
TotalCount	Integer	`15`	查询到的符合条件的条目总数。

Result

参数	类型	示例值	描述
InsList	Array of InsList	`--`	实例列表详情。

InsList

参数	类型	示例值	描述
AttackCount	Integer	`5`	实例所受攻击次数。
AutoRenew	Boolean	`true`	是否开启自动续费。 true：开启。 false：关闭。
BizBand	Integer	`50`	业务带宽，单位：Mbps。
DefBand	Integer	`300`	标准防护带宽，单位：Gbps。
ElaBand	Integer	`500`	弹性防护带宽，单位：Gbps。
ElaBandStatus	Integer	`1`	弹性带宽生效状态。 1: 正常 2: 欠费关停
Id	Integer	`20`	实例 ID。
IpNum	Integer	`10`	实例可防护的 IP 总数。
IsDemoted	Boolean	`false`	防护能力是否被降级。 true：已降级。 false：未降级。
Name	String	`test-addbymanage`	实例名称。
PeakAttackBand	Integer	`3427150`	实例所受攻击峰值。单位：Kbps。
Region	String	`cn-beijing`	实例所属地域。 cn-beijing：华北 2（北京） cn-shanghai：华东 2（上海） cn-guangzhou：华南 1（广州） ap-southeast-1：亚太东南（柔佛）
ReserveIpNum	Integer	`3`	预占资源配额数，创建 ECS 实例时绑定企业版防护资源包，此时需要预占原生防护资源配额，该预占配额数量为需要创建的 ECS 实例数量。更多预占资源的说明，可参考弹性预约实例概述。说明仅增强型防护 EIP 涉及。
Spec	String	`Deluxe`	实例套餐规格。 Enterprise：企业版 Deluxe：高级版
StartAt	Integer	`1681943881`	实例购买起始时间，秒级时间戳。
Status	Integer	`1`	实例计费状态。 1：运行中 2：过期关停
StopAt	Integer	`1684511999`	实例到期时间，秒级时间戳。
UsedIpNum	Integer	`1`	已使用的防护 IP 数量。

请求示例

GET https://open.volcengineapi.com/?Action=DescInstanceList&Version=2022-01-01&CurrPage=1&PageSize=10&SearchName=test&Spec=Deluxe
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240610T082509Z
X-content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240610/cn-beijing/origin_defence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240621164540****17B3A0134FE3A397",
        "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": 1,
                "ReserveIpNum": 0,
                "IpNum": 10,
                "BizBand": 50,
                "Name": "ddos-d356ef3ff34c402a9f1ef7d8ce****",
                "PeakAttackBand": 0,
                "Status": 1,
                "StartAt": 1681462614,
                "StopAt": 1720972799,
                "Region": "cn-beijing",
                "Spec": "Enterprise",
                "ElaBandStatus": 1,
                "IsDemoted": false
            },
            {
                "Id": 30,
                "AttackCount": 4,
                "AutoRenew": true,
                "DefBand": 300,
                "ElaBand": 300,
                "UsedIpNum": 0,
                "ReserveIpNum": 0,
                "IpNum": 10,
                "BizBand": 50,
                "Name": "test2",
                "PeakAttackBand": 1593540,
                "Status": 1,
                "StartAt": 1684758770,
                "StopAt": 1747929599,
                "Region": "cn-beijing",
                "Spec": "Enterprise",
                "ElaBandStatus": 1,
                "IsDemoted": false
            },
            {
                "Id": 32,
                "AttackCount": 3,
                "AutoRenew": true,
                "DefBand": 300,
                "ElaBand": 300,
                "UsedIpNum": 0,
                "ReserveIpNum": 0,
                "IpNum": 10,
                "BizBand": 50,
                "Name": "test3",
                "PeakAttackBand": 127010,
                "Status": 1,
                "StartAt": 1684760147,
                "StopAt": 1721663999,
                "Region": "cn-beijing",
                "Spec": "Enterprise",
                "ElaBandStatus": 1,
                "IsDemoted": false
            }
        ]
    },
    "PageInfo": {
        "TotalCount": 3,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 10
    }
}