DescribeInstanceAttribute - 查询实例属性信息 - 运维安全中心（堡垒机）

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-bastionhost:DescribeInstanceAttribute	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	要查询的堡垒机实例所在的地域 ID。	cn-hangzhou
InstanceId	string	是	要查询的堡垒机的实例的 ID。说明可通过调用 DescribeInstances 接口获取堡垒机实例 ID。	bastionhost-cn-78v1ghxxxxx

返回参数

名称	类型	描述	示例值
	object	响应参数。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	082FAB35-6AB9-4FD5-8750-D36673548E76
InstanceAttribute	object	实例属性信息。
VpcId	string	实例绑定的 VPC ID。	vpc-bp1c85tzgqu1bf5bxxxxx
VswitchId	string	实例绑定的交换机 ID。	vsw-bp1xfwzzfti0kjbfxxxxx
Description	string	备注信息。	测试API
ExpireTime	long	堡垒机实例的到期的时间戳。单位为毫秒。	1578326400000
ModifyPasswordModule	string	改密任务功能状态。 Enable：开启 Disable：关闭	Enable
EniInstanceId	string	弹性网卡 ID。	eni-bp1455jrzwm7moaxxxxx
InstanceId	string	实例 ID。	bastionhost-cn-78v1ghxxxxx
InternetEndpoint	string	公网域名。	******lwb-public.bastionhost.aliyuncs.com
RegionId	string	实例所在的地域 ID。	cn-hangzhou
IntranetEndpoint	string	内网域名。	******xalwb.bastionhost.aliyuncs.com
StartTime	long	堡垒机实例的购买或续费的时间戳。单位为毫秒。	1577681345000
ResourceGroupId	string	实例所在的企业资源组的 ID。	rg-aekzc427db******
NetworkProxyModule	string	网络域代理状态。 Enable：支持网络域代理模式。 Disable：不支持网络域代理模式。	Enable
WebTerminalModule	string	Web Terminal 状态。 Enable：支持 Web 远程连接。 Disable：不支持 Web 远程连接。	Enable
InstanceStatus	string	实例状态。取值范围： PENDING：未初始化 CREATING：创建中 RUNNING：运行中 EXPIRED：已过期 CREATE_FAILED：创建失败 UPGRADING：变配中 UPGRADE_FAILED：变配失败	RUNNING
LicenseCode	string	许可 Code。	bhah_ent_50_asset
PublicNetworkAccess	boolean	公网是否可以访问该堡垒机实例。取值： true：公网可以访问该堡垒机 false：公网不可访问该堡垒机	true
Storage	long	已购买堡垒机的存储总量。单位：Byte	2199023255552
Ports	array<object>	堡垒机运维端口。
Port	object	堡垒机运维端口。
StandardPort	integer	堡垒机标准端口。取值如下： SSH ：60022 RDP ：63389 HTTPS ：443	60022
CustomPort	integer	用户自定义端口。说明仅 SSH、RDP 支持修改，如果未自定义堡垒机运维端口，返回与标准端口一致。	600xx
PublicExportIps	array	堡垒机公网出口 IP 列表。
PublicExportIp	string	堡垒机公网出口 IP。	[10.162.168.xx/32]
PublicWhiteList	array	堡垒机公网白名单列表。
Cidr	string	堡垒机公网白名单 IP。	[10.162.168.xx/32]
AuthorizedSecurityGroups	array	已授权的安全组 ID 列表。
AuthorizedSecurityGroup	string	已授权的安全组 ID。	[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIps	array	堡垒机内网出口 IP 列表。
PrivateExportIp	string	堡垒机内网出口 IP。	192.168.xx.xx
PublicIps	array	堡垒机公网 IP 列表。
PublicIp	string	堡垒机公网 IP。	116.62.xx.xx
SecurityGroupIds	array	实例所属安全组 ID 列表。
SecurityGroupId	string	实例所属安全组 ID。	sg-bp15ed6xe1yxeycg7o****
PrivateWhiteList	array	内网白名单 IP 列表。
PrivateIp	string	内网白名单 IP。	192.168.xx.xx
Bandwidth	string	堡垒机实例总带宽。	30
BandwidthPackage	string	堡垒机扩展带宽包。	5
DbOperationModule	string	数据库运维状态。 Enable：支持数据库运维。 Disable：不支持数据库运维。	Disable

示例

正常返回示例

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": "******lwb-public.bastionhost.aliyuncs.com",
    "RegionId": "cn-hangzhou",
    "IntranetEndpoint": "******xalwb.bastionhost.aliyuncs.com",
    "StartTime": 1577681345000,
    "ResourceGroupId": "rg-aekzc427db******",
    "NetworkProxyModule": "Enable",
    "WebTerminalModule": "Enable",
    "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",
    "DbOperationModule": "Disable",
    "RouterRules": [
      ""
    ],
    "IDaaSModule": "",
    "SlaveVswitchId": "",
    "ScriptDeliverModule": "",
    "KmsSecretModule": "",
    "RDModule": "",
    "HSMModule": "",
    "WhiteListPolicies": [
      {
        "Entry": "",
        "Description": ""
      }
    ],
    "AppOperationModule": ""
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-07-18	OpenAPI 返回结构发生变更	查看变更详情