文档中心

ListInstances

最近更新时间：2024.04.16 19:47:29

首次发布时间：2023.12.15 10:45:21

获取云堡垒机实例列表，可根据分页及实例 ID、运行状态、名称等条件条件筛选符合要求的云堡垒机实例列表。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListInstances&Version=2021-06-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListInstances	接口名称。当前 API 的名称为 `ListInstances`。
Version	String	是	2021-06-01	接口版本。当前 API 的版本为 `2021-06-01`。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数。最小值：1 最大值：100 默认值：10
Filter	Object of ListInstancesFilter	否		待查询云堡垒机实例的筛选条件。

ListInstancesFilter

参数	类型	是否必选	示例值	描述
Keyword	String	否	vbh-mlt	关键字。可根据关键字模糊匹配云堡垒机实例名称，进行模糊搜索。
Status	Array of String	否	["Creating"]	云堡垒机实例的运行状态，取值： creating：创建中 running：运行中 deleting：删除中 changing：更配中 upgrading：升级中 failed：异常 stopped：到期关停 updating：更新中 unknown：未知状态
InstanceIds	Array of String	否	["vbh-2100****-bd8**"]	云堡垒机实例 ID 列表。

参数

类型

是否必选

示例值

描述

Keyword

String

否

vbh-mlt

关键字。可根据关键字模糊匹配云堡垒机实例名称，进行模糊搜索。

Status

Array of String

否

["Creating"]

云堡垒机实例的运行状态，取值：

creating：创建中
running：运行中
deleting：删除中
changing：更配中
upgrading：升级中
failed：异常
stopped：到期关停
updating：更新中
unknown：未知状态

InstanceIds

Array of String

否

["vbh-2100******-bd8****"]

云堡垒机实例 ID 列表。

请求示例

POST https://open.volcengineapi.com/?Action=ListInstances&Version=2021-06-01
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filter": {
        "Keyword": "center",
        "Status": ["Creating", "Running", "Starting", "Stopping", "Updating", "Upgrading", "Failed", "Stopped"],
        "InstanceIds": ["vbh-2100******-bd8****"]
    }
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	2	返回数据列表的总量。
PageNumber	Integer	1	当前页数。
PageSize	Integer	10	每页显示的数量。
Items	Array of Instance		云堡垒机实例详情列表。

Instance

参数	类型	示例值	描述
Ip	String	192.168.0.2	云堡垒机实例的内网 IP。
Eip	String	102.123.4.105	云堡垒机实例的公网 IP。
Name	String	vbh-mlt	云堡垒机实例名称。
Port	Integer	2002	开放访问端口。
VpcId	String	vpc-3reyos6***hn6**	云堡垒机实例使用的私有网络 ID。
Flavor	Object of FlavorInfoV2		云堡垒机实例规格。
Status	String	Creating	云堡垒机实例状态，取值： creating：创建中 running：运行中 deleting：删除中 changing：更配中 upgrading：升级中 failed：异常 stopped：到期关停 updating：更新中 unknown：未知状态
ZoneId	String	cn-beijing-a	云堡垒机实例所属可用区。
Version	String	v1.6.3	云堡垒机实例当前版本。
RegionId	String	cn-beijing	云堡垒机实例所属区域。
SubnetId	String	subnet-3reyo**********ls5zsk2	云堡垒机实例使用的子网 ID。
CreateTime	String	2023-09-12 10:34:30	云堡垒机实例创建时间。
DeleteTime	String	2023-09-12 10:34:30	云堡垒机实例删除时间。
InstanceId	String	vbh-1400****-gmwd**	云堡垒机实例 ID。
UpdateTime	String	2023-09-12 10:34:30	云堡垒机实例修改时间。
ExpiredTime	String	2023-09-12 10:34:30	云堡垒机实例到期时间。
LatestVersion	String	v1.7.5	云堡垒机实例最新版本。
SecurityGroupIds	Array of String	["sg-3re*****ts5zsk2h***"]	云堡垒机实例绑定的安全组 ID 列表。
EniSecurityGroupId	String	sg-2d5w********w58ozfd	用户 ENI 网卡上自动创建的安全组 ID。
BandwidthExpansionPack	Integer	4	带宽扩展包，单位Mbps。

FlavorInfoV2

参数	类型	示例值	描述
FlavorId	String	vbh_instance_cost_100_assets	云堡垒机规格 ID。
FlavorName	String	100 资产	云堡垒机规格名称。
HostTotal	Long	100	云堡垒机规格中提供的资产数。
Concurrent	Long	100	云堡垒机规格中提供的并发连接数。
BandWidth	Long	20	云堡垒机规格中提供的带宽，单位：Mbps。
Storage	Long	20	云堡垒机规格中提供的存储，单位：GB。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202211302208****",
        "Action": "ListInstances",
        "Version": "2021-06-01",
        "Service": "vbh",
        "Region": "cn-beijing"
    },
    "Result": {
        "TotalCount": 2,
        "PageNumber": 1,
        "PageSize": 2,
        "Items": [
            {
                "InstanceId": "vbh-14****0042-wdk****z",
                "CreateTime": "2023-09-12 10:34:30",
                "UpdateTime": "2023-09-12 10:34:30",
                "Name": "vbh-mlt",
                "RegionId": "cn-beijing",
                "ZoneId": "cn-beijing-a",
                "VpcId": "vpc-3reyos******g5zsk2hn63665",
                "SubnetId": "subnet-3reyosuf******zsk2hri0gr3",
                "SecurityGroupIds": ["sg-3reyoscnx2l******hcdml5f"],
                "Ip": "192.168.0.2",
                "Eip": "102.123.4.105",
                "Status": "Creating",
                "EniSecurityGroupId": "sg-2d5wzvq7ro8******fd3d2z5a",
                "Flavor": {
                    "FlavorId": "vbh_instance_cost_100_assets",
                    "HostTotal": 100,
                    "Concurrent": 100,
                    "BandWidth": 20,
                    "Storage": 20,
                    "FlavorName": "100 资产",
                    "Id": "vbh_instance_cost_200_assets",
                    "Name": "vbh-lin"
                },
                "ExpiredTime": "2023-09-12 10:34:30",
                "DeleteTime": "2023-09-12 10:34:30",
                "Version": "v1.6.3",
                "LatestVersion": "v1.6.3",
                "Port": 3333,
                "BandwidthExpansionPack": 22
            }
        ]
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。