DescInstance-查询实例基本信息--DDoS防护-火山引擎

文档中心

立即注册

导航

DescInstance-查询实例基本信息

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

根据实例 ID，查询单个实例的基本信息。

请求说明

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

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescInstance`	接口名称。当前 API 的名称为 `DescInstance`。
Version	String	是	`2022-01-01`	接口版本。当前 API 的版本为 `2022-01-01`。
InsId	Integer	是	`20`	防护实例的 ID，可调用DescInstanceLis接口获取具体值。

返回参数

参数	类型	示例值	描述
Status	Integer	`1`	实例计费状态。 1：运行中。 2：过期关停。
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`	实例购买起始时间，秒级时间戳。
StopAt	Integer	`1684511999`	实例到期时间，秒级时间戳。
UsedIpNum	Integer	`1`	已使用的防护 IP 数量。

请求示例

GET https://open.volcengineapi.com/?Action=DescInstance&Version=2022-01-01&InsId=20
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": {
        "Action": "DescInstance",
        "Region": "cn-beijing",
        "RequestId": "20230604110420****100232280022D31",
        "Service": "origin_defence",
        "Version": "2022-01-01"
    },
    "Result": {
        "Id": 44,
        "AttackCount": 16,
        "AutoRenew": true,
        "DefBand": 0,
        "ElaBand": 0,
        "UsedIpNum": 3,
        "ReserveIpNum": 0,
        "IpNum": 50,
        "BizBand": 3000,
        "Name": "test1",
        "PeakAttackBand": 80817,
        "Status": 1,
        "StartAt": 1692624656,
        "StopAt": 1721577599,
        "Region": "cn-beijing",
        "Spec": "Deluxe",
        "ElaBandStatus": 1,
        "IsDemoted": false
    }
}