全部产品
Search
文档中心

运维安全中心(堡垒机):DescribeInstanceAttribute - 查询实例属性信息

更新时间:Mar 01, 2024

查询实例所有的属性信息,例如:实例ID、实例的备注信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-bastionhost:DescribeInstanceAttributeRead
  • 全部资源
    *

请求参数

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

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

cn-hangzhou
InstanceIdstring

要查询的堡垒机的实例的 ID。

bastionhost-cn-78v1ghxxxxx

返回参数

名称类型描述示例值
object

响应参数。

RequestIdstring

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

082FAB35-6AB9-4FD5-8750-D36673548E76
InstanceAttributeobject

实例属性信息。

VpcIdstring

实例绑定的 VPC ID。

vpc-bp1c85tzgqu1bf5bxxxxx
VswitchIdstring

实例绑定的交换机 ID。

vsw-bp1xfwzzfti0kjbfxxxxx
Descriptionstring

备注信息。

测试API
ExpireTimelong

过期时间。

1578326400000
ModifyPasswordModulestring

改密任务功能状态。

  • Enable:开启
  • Disable:关闭
Enable
EniInstanceIdstring

弹性网卡 ID。

eni-bp1455jrzwm7moaxxxxx
InstanceIdstring

实例 ID。

bastionhost-cn-78v1ghxxxxx
InternetEndpointstring

公网域名。

drawvxalwb-public.bastionhost.aliyuncs.com
RegionIdstring

垒机实例所在的地域 ID。

cn-hangzhou
IntranetEndpointstring

内网域名。

drawvxalwb.bastionhost.aliyuncs.com
StartTimelong

实例的开始时间。

1577681345000
ResourceGroupIdstring

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

rg-aekzc427dbl2shy
NetworkProxyModulestring

网络域代理状态。

  • Enable:开启
  • Disable:关闭
Enable
WebTerminalModulestring

Web Terminal 状态。

  • Enable:开启
  • Disable:关闭
Enable
DbOperationModulestring

数据库运维状态。

Disable
InstanceStatusstring

实例状态。取值范围:

  • PENDING:未初始化
  • CREATING:创建中
  • RUNNING:运行中
  • EXPIRED:已过期
  • CREATE_FAILED:创建失败
  • UPGRADING:变配中
  • UPGRADE_FAILED:变配失败
RUNNING
LicenseCodestring

许可 Code。

bhah_ent_50_asset
PublicNetworkAccessboolean

公网是否可访问该堡垒机。

true
Storagelong

已购买堡垒机的存储总量。

2199023255552
Portsobject []

堡垒机运维端口

StandardPortinteger

堡垒机标准端口。取值如下:

  • SSH :60022
  • RDP :63389
  • HTTPS :443
60022
CustomPortinteger

用户自定义端口。

说明 仅 SSH、RDP 支持修改 ,如果未自定义堡垒机运维端口,返回与标准端口一致。
600xx
PublicExportIpsarray

堡垒机公网出口 IP 列表。

string

堡垒机公网出口 IP。

[10.162.168.xx/32]
PublicWhiteListarray

堡垒机公网白名单列表。

string

堡垒机公网白名单 IP。

[10.162.168.xx/32]
AuthorizedSecurityGroupsarray

已授权的安全组 ID 列表。

string

已授权的安全组 ID。

[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIpsarray

堡垒机内网出口 IP 列表。

string

堡垒机内网出口 IP。

192.168.xx.xx
PublicIpsarray

堡垒机公网 IP 列表。

string

堡垒机公网 IP。

116.62.xx.xx
SecurityGroupIdsarray

实例所属安全组 ID 列表。

string

实例所属安全组 ID。

sg-bp15ed6xe1yxeycg7o****
PrivateWhiteListarray

内网白名单 IP 列表。

string

内网白名单 IP。

192.168.xx.xx
Bandwidthstring

堡垒机实例总带宽。

30
BandwidthPackagestring

堡垒机扩展带宽包。

5

示例

正常返回示例

JSON格式

{
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "InstanceAttribute": {
    "VpcId": "vpc-bp1c85tzgqu1bf5bxxxxx",
    "VswitchId": "vsw-bp1xfwzzfti0kjbfxxxxx",
    "Description": "测试API",
    "ExpireTime": 1578326400000,
    "ModifyPasswordModule": "Enable",
    "EniInstanceId": "eni-bp1455jrzwm7moaxxxxx",
    "InstanceId": "bastionhost-cn-78v1ghxxxxx",
    "InternetEndpoint": "drawvxalwb-public.bastionhost.aliyuncs.com",
    "RegionId": "cn-hangzhou",
    "IntranetEndpoint": "drawvxalwb.bastionhost.aliyuncs.com",
    "StartTime": 1577681345000,
    "ResourceGroupId": "rg-aekzc427dbl2shy",
    "NetworkProxyModule": "Enable",
    "WebTerminalModule": "Enable",
    "DbOperationModule": "Disable",
    "InstanceStatus": "RUNNING",
    "LicenseCode": "bhah_ent_50_asset",
    "PublicNetworkAccess": true,
    "Storage": 2199023255552,
    "Ports": [
      {
        "StandardPort": 60022,
        "CustomPort": 0
      }
    ],
    "PublicExportIps": [
      "[10.162.168.xx/32]"
    ],
    "PublicWhiteList": [
      "[10.162.168.xx/32]"
    ],
    "AuthorizedSecurityGroups": [
      "[sg-bp14u00sh39jvw5xxxxx]"
    ],
    "PrivateExportIps": [
      "192.168.xx.xx"
    ],
    "PublicIps": [
      "116.62.xx.xx"
    ],
    "SecurityGroupIds": [
      "sg-bp15ed6xe1yxeycg7o****"
    ],
    "PrivateWhiteList": [
      "192.168.xx.xx"
    ],
    "Bandwidth": "30",
    "BandwidthPackage": "5"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更