You need to enable JavaScript to run this app.
导航
云堡垒机
  • 文档首页
    • /云堡垒机/API 参考/实例管理/ListInstances
ListInstances
最近更新时间：2025.05.23 17:57:31首次发布时间：2023.12.15 10:45:21
我的收藏
有用
有用
无用
无用

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

请求说明

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

请求参数

参数类型是否必选示例值描述
ActionString是ListInstances接口名称。当前 API 的名称为 ListInstances。
VersionString是2021-06-01接口版本。当前 API 的版本为 2021-06-01。
PageNumberInteger否1分页查询时的起始页码，从 1 开始，默认为 1。

PageSize

Integer

否

10

分页查询时每页显示的记录数。

  • 最小值：1
  • 最大值：100
  • 默认值：10
FilterObject of ListInstancesFilter否{"Keyword": "word"}待查询云堡垒机实例的筛选条件。
TagFiltersArray of TagFilter否标签筛选器

ListInstancesFilter

参数类型是否必选示例值描述
StatusArray of String否["Creating", "Running", "Starting", "Stopping", "Updating", "Upgrading", "Failed", "Stopped"]状态
KeywordString否keyword模糊搜索
InstanceIdsArray of String否["vbh-2100000924-bd84rrwc"]堡垒机Ids

TagFilter

参数类型是否必选示例值描述
KeyString是key标签 key
ValuesArray of String否["value1", "value2"]标签值列表

请求示例

POST https://vbh.{RegionID}.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****"
        ]
    }
}

返回参数

参数类型示例值描述
TotalCountLong2返回数据列表的总量。
PageNumberInteger1当前页数。
PageSizeInteger10每页显示的数量。
ItemsArray of Instance[{"InstanceId":"vbh-1400000042-wxvqsx9f","CreateTime":"2022-06-23T09:45:03Z","UpdateTime":"2022-06-23T10:35:22Z","Name":"test","RegionId":"cn-guilin-boe","ZoneId":"cn-guilin-a","VpcId":"vpc-3reyos6qtqfwg5zsk2hn63665","SubnetId":"subnet-3reyosuf733ls5zsk2hri0gr3","SecurityGroupIds":["sg-3reyoscnx2lts5zsk2hcdml5f"],"Ip":"172.16.0.26","Eip":"10.249.156.38","Status":"running","EniSecurityGroupId":"sg-2d5wzvq7ro8ow58ozfd3d2z5a","Flavor":{"FlavorId":"vbh_instance_cost_100_assets","HostTotal":100,"Concurrent":100,"BandWidth":8,"Storage":1000,"FlavorName":"100资产","Id":"","Name":""},"ExpiredTime":"2022-07-23 23:59:59","DeleteTime":"2022-08-07 23:59:59","Version":"v1.6.3","LatestVersion":"v1.0.0","Port":0}]云堡垒机实例详情列表。

Instance

参数类型示例值描述
IpString10.85.0.0内网IP
EipString2.2.2.2公网IP
NameStringtest堡垒机名称
PortInteger3333端口
VpcIdStringvpc-3reyos6qtqfwg5zsk2hn63665私有网络 ID
FlavorObject of FlavorInfoV2{"FlavorId":"vbh_instance_cost_100_assets","HostTotal":100,"Concurrent":100,"BandWidth":8,"Storage":1000,"FlavorName":"100资产","Id":"","Name":""}堡垒机规格
StatusStringCreating"、"Running"、"Starting"、"Stopping"、"Updating"、"Upgrading"、"Failed" 或 "Stopped堡垒机状态
ZoneIdStringlf-zone-a可用区
ProjectStringdefault项目
VersionStringv1.6.3堡垒机版本
RegionIdStringcn-north-4区域
SubnetIdStringsubnet-3reyosuf733ls5zsk2hri0gr3子网 ID
CreateTimeString2022-12-12 22:22:22创建时间
CustomTagsArray of Tag[{"Key": "key1", "Value": "value1"}]用户标签
DeleteTimeString2022-12-12 22:22:22删除时间
InstanceIdStringvbh-1400000042-gmwdrmltID
SystemTagsArray of Tag[{"Key": "key1", "Value": "value1"}]系统标签
UpdateTimeString2022-12-12 22:22:22修改时间
ExpiredTimeString2022-12-12 22:22:22到期时间
LatestVersionStringv1.6.3最新版本
SecurityGroupIdsArray of String["sg-3reyoscnx2lts5zsk2hcdml5f"]安全组 ID 列表
EniSecurityGroupIdStringsg-2d5wzvq7ro8ow58ozfd3d2z5a用户 Eni 网卡上自动创建的安全组 ID
BandwidthExpansionPackInteger22带宽扩展包
EnableDatabaseBooleantrue开启数据库资产运维

FlavorInfoV2

参数类型示例值描述
IdStringvbh_instance_cost_200_assetsID（deprecated）
NameStringtest名称（deprecated）
StorageLong20存储
FlavorIdStringvbh_instance_cost_200_assetsID
BandWidthLong20带宽
HostTotalLong100资产数
ConcurrentLong100并发连接数
FlavorNameString100 资产名称

Tag

参数类型示例值描述
KeyStringkeyTag key
ValueStringvalueTag value

返回示例

{
    "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
            }
        ]
    }
}

错误码

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