DescInstanceList - 获取实例列表--DDoS防护-火山引擎

文档中心

立即注册

导航

DescInstanceList - 获取实例列表

最近更新时间：2024.05.29 11:03:22首次发布时间：2024.05.20 21:52:14

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

请求说明

请求方式：GET
请求地址：https://open.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	InstanceList	--	查询到的实例列表信息。
PageInfo	PageInfo	--	分页信息。

请求示例

POST /?Action=DescInstanceList&Version=2021-06-15&CurrPage=1&PageSize=10 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240514T082509Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240514/cn-beijing/AdvDefence/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202405201141525AF0E574A75A0483****",
        "Action": "DescInstanceList",
        "Version": "2021-06-15",
        "Service": "AdvDefence",
        "Region": "cn-beijing"
    },
    "Result": {
        "InsList": [
            {
                "Id": 676,
                "InsIp": "240e:f7:7c00:***:***",
                "Name": "new_ins_240e:f7:7c00:***:***",
                "StartAt": 1709519438,
                "StopAt": 1733365838,
                "ShutdownAt": 0,
                "BizBand": 200,
                "DefBand": 30,
                "ElaBand": 100,
                "ElaBizBand": 0,
                "ElaBizBandSwitch": 0,
                "PortNum": 5,
                "HostNum": 3,
                "PortLimit": 60,
                "HostLimit": 60,
                "AttackPeak": 0,
                "AttackCount": 0,
                "AutoRenew": false,
                "Region": "ChinaHdNew",
                "ProjectName": "",
                "Type": 3,
                "Provider": "shenke",
                "IpType": 6,
                "Status": 1,
                "ElaBandStatus": 1,
                "StatusName": "running"
            },
            {
                "Id": 663,
                "InsIp": "120.241.***.***",
                "Name": "华南120.241.***.***网段拨测专用",
                "StartAt": 1706535146,
                "StopAt": 1717171199,
                "ShutdownAt": 0,
                "BizBand": 100,
                "DefBand": 20,
                "ElaBand": 20,
                "ElaBizBand": 0,
                "ElaBizBandSwitch": 0,
                "PortNum": 3,
                "HostNum": 1,
                "PortLimit": 60,
                "HostLimit": 60,
                "AttackPeak": 0,
                "AttackCount": 0,
                "AutoRenew": true,
                "Region": "ChinaHn",
                "ProjectName": "default",
                "Type": 2,
                "Provider": "yifang",
                "IpType": 4,
                "Status": 1,
                "ElaBandStatus": 1,
                "StatusName": "running"
            },
            {
                "Id": 591,
                "InsIp": "103.143.***.***",
                "Name": "new_ins_103.143.***.***",
                "StartAt": 1701057409,
                "StopAt": 1701057409,
                "ShutdownAt": 0,
                "BizBand": 100,
                "DefBand": 20,
                "ElaBand": 20,
                "ElaBizBand": 0,
                "ElaBizBandSwitch": 0,
                "PortNum": 0,
                "HostNum": 1,
                "PortLimit": 60,
                "HostLimit": 60,
                "AttackPeak": 0,
                "AttackCount": 0,
                "AutoRenew": false,
                "Region": "ChinaHb",
                "ProjectName": "",
                "Type": 3,
                "Provider": "haiyuV2",
                "IpType": 4,
                "Status": 1,
                "ElaBandStatus": 1,
                "StatusName": "expired"
            }
        ],
        "TotalCount": 3
    },
    "PageInfo": {
        "TotalCount": 3,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 3
    }
}

错误码

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

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