文档

DescribeInstances - 查询实例的列表信息

查询实例的列表信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PageNumberinteger

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
PageSizeinteger

设置分页查询时,每页显示的堡垒机实例的数量。默认值为 10,表示每页显示 10 条堡垒机实例信息。

10
RegionIdstring

实例所在的地域 ID。

cn-hangzhou
InstanceStatusstring

堡垒机实例的状态。取值:

  • PENDING:未初始化

  • CREATING:创建中

  • RUNNING:运行中

  • EXPIRED:已过期

  • CREATE_FAILED:创建失败

  • UPGRADING:变配中

  • UPGRADE_FAILED:变配失败

RUNNING
ResourceGroupIdstring

堡垒机实例所在的企业资源组的 ID。

rg-acfm26ougi****
InstanceIdarray

堡垒机实例的 ID。

string

堡垒机实例的 ID。

2
Tagobject []

堡垒机实例的标签信息。

Keystring

实例的标签键。

test
Valuestring

实例的标签值。

testapi

返回参数

名称类型描述示例值
object
TotalCountlong

查询到的堡垒机实例的总数量。

4
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

61D36C55-AAFC-4678-8FAD-34FEF9E7182E
Instancesobject []

查询到的堡垒机实例的列表。

VpcIdstring

堡垒机实例绑定的 VPC ID。

vpc-bp1c85tzgqu1bf5b****
VswitchIdstring

堡垒机实例绑定的交换机 ID。

vsw-bp1xfwzzfti0kjbf****
ImageVersionstring

堡垒机实例镜像的版本。

3.0.0
PlanCodestring

堡垒机实例的规格。取值:

  • cloudbastion:基础版
  • cloudbastion_ha:企业双擎版
cloudbastion_ha
Descriptionstring

堡垒机实例的备注信息。

测试API
ExpireTimelong

堡垒机实例的到期的时间戳。单位为毫秒。

1578326400000
Legacyboolean

该堡垒机实例是否为旧版堡垒机实例。取值:

  • true:表示 V2 和 V3.1 系列的堡垒机实例。

  • false:表示 V3.2 系列的堡垒机实例。

false
InstanceIdstring

堡垒机的实例 ID。

bastionhost-cn-78v1gh****
InternetEndpointstring

堡垒机实例的公网域名。

drawvxalwb-public.bastionhost.aliyuncs.com
RegionIdstring

堡垒机实例所在的地域 ID。

cn-hangzhou
IntranetEndpointstring

堡垒机实例的私网域名。

drawvxalwb.bastionhost.aliyuncs.com
StartTimelong

堡垒机实例的购买或续费的时间戳。单位为毫秒。

1577681345000
ResourceGroupIdstring

堡垒机实例所在的企业资源组的 ID。

g-acfm26ougi****
InstanceStatusstring

堡垒机实例的状态。取值:

  • PENDING:未初始化

  • CREATING:创建中

  • RUNNING:运行中

  • EXPIRED:已过期

  • CREATE_FAILED:创建失败

  • UPGRADING:变配中

  • UPGRADE_FAILED:变配失败

RUNNING
LicenseCodestring

堡垒机实例的许可 Code。

bhah_ent_50_asset
PublicNetworkAccessboolean

公网是否可以访问该堡垒机实例。取值:

  • true:公网可以访问该堡垒机
  • false:公网不可访问该堡垒机
true

示例

正常返回示例

JSON格式

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

错误码

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

  • 本页导读 (1)
文档反馈