使用DescribeInstances查询堡垒机实例列表信息-运维安全中心（堡垒机）-阿里云

查询实例的列表信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-bastionhost:DescribeInstanceBastionhost

get

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

无

请求参数

名称	类型	必填	描述	示例值
PageNumber	integer	否	设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。	1
PageSize	integer	否	设置分页查询时，每页显示的堡垒机实例的数量。默认值为 10，表示每页显示 10 条堡垒机实例信息。	10
PageNumber	integer	否	设置从返回结果的第几页开始显示查询结果。默认值为 1，表示从第 1 页开始显示。	1
RegionId	string	否	实例所在的地域 ID。	cn-hangzhou
InstanceStatus	string	否	堡垒机实例的状态。取值： PENDING：未初始化 CREATING：创建中 RUNNING：运行中 EXPIRED：已过期 CREATE_FAILED：创建失败 UPGRADING：变配中 UPGRADE_FAILED：变配失败	RUNNING
ResourceGroupId	string	否	堡垒机实例所在的企业资源组的 ID。	rg-acfm26ougi****
InstanceId	array	否	堡垒机实例的 ID。	bastionhost-cn-78v1ghxxxxx
	string	否	堡垒机实例的 ID。	2
Tag	array<object>	否	堡垒机实例的标签信息。
	object	否	堡垒机实例的标签信息。
Key	string	否	实例的标签键。	test
Value	string	否	实例的标签值。	testapi

返回参数

名称	类型	描述	示例值
	object
TotalCount	integer	查询到的堡垒机实例的总数量。	4
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	61D36C55-AAFC-4678-8FAD-34FEF9E7182E
Instances	array<object>	查询到的堡垒机实例的列表。
	object
VpcId	string	堡垒机实例绑定的 VPC ID。	vpc-bp1c85tzgqu1bf5b****
VswitchId	string	堡垒机实例绑定的交换机 ID。	vsw-bp1xfwzzfti0kjbf****
ImageVersion	string	堡垒机实例镜像的版本。	3.2.41
PlanCode	string	堡垒机实例的规格。取值： cloudbastion：基础版 cloudbastion_ha：企业双擎版	cloudbastion_ha
Description	string	堡垒机实例的备注信息。	测试API
ExpireTime	integer	堡垒机实例的到期的时间戳。单位为毫秒。	1578326400000
Legacy	boolean	该堡垒机实例是否为旧版堡垒机实例。取值： true：表示 V2 和 V3.1 系列的堡垒机实例。 false：表示 V3.2 系列的堡垒机实例。	false
InstanceId	string	堡垒机的实例 ID。	bastionhost-cn-78v1gh****
InternetEndpoint	string	堡垒机实例的公网域名。	******lwb-public.bastionhost.aliyuncs.com
RegionId	string	堡垒机实例所在的地域 ID。	cn-hangzhou
IntranetEndpoint	string	堡垒机实例的私网域名。	******lwb.bastionhost.aliyuncs.com
StartTime	integer	堡垒机实例的购买或续费的时间戳。单位为毫秒。	1577681345000
ResourceGroupId	string	堡垒机实例所在的企业资源组的 ID。	g-acfm26ougi****
InstanceStatus	string	堡垒机实例的状态。取值： PENDING：未初始化 CREATING：创建中 RUNNING：运行中 EXPIRED：已过期 CREATE_FAILED：创建失败 UPGRADING：变配中 UPGRADE_FAILED：变配失败	RUNNING
LicenseCode	string	堡垒机实例的许可 Code。	bhah_ent_50_asset
PublicNetworkAccess	boolean	公网是否可以访问该堡垒机实例。取值： true：公网可以访问该堡垒机 false：公网不可访问该堡垒机	true
SlaveVswitchId	string
BandWidth	integer

示例

正常返回示例

JSON格式

{
  "TotalCount": 4,
  "RequestId": "61D36C55-AAFC-4678-8FAD-34FEF9E7182E",
  "Instances": [
    {
      "VpcId": "vpc-bp1c85tzgqu1bf5b****",
      "VswitchId": "vsw-bp1xfwzzfti0kjbf****",
      "ImageVersion": "3.2.41",
      "PlanCode": "cloudbastion_ha",
      "Description": "测试API",
      "ExpireTime": 1578326400000,
      "Legacy": false,
      "InstanceId": "bastionhost-cn-78v1gh****",
      "InternetEndpoint": "******lwb-public.bastionhost.aliyuncs.com",
      "RegionId": "cn-hangzhou",
      "IntranetEndpoint": "******lwb.bastionhost.aliyuncs.com",
      "StartTime": 1577681345000,
      "ResourceGroupId": "g-acfm26ougi****",
      "InstanceStatus": "RUNNING",
      "LicenseCode": "bhah_ent_50_asset",
      "PublicNetworkAccess": true,
      "SlaveVswitchId": "",
      "BandWidth": 0
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。