调用GetInstance获取实例详情_实时数仓 Hologres(Hologres)-阿里云帮助中心

获取实例详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
hologram:GetInstance	Read	全部资源 *	无	无

请求语法

GET /api/v1/instances/{instanceId}

请求参数

名称	类型	必填	描述	示例值
instanceId	string	否	实例 ID。该参数必填。	hgprecn-cn-i7m2v08uu00a

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	865A02C2-B374-5DD4-9B34-0CA15DA1AEBD
Instance	object	实例信息。
InstanceChargeType	string	实例付费类型。枚举值： PostPaid：按量付费。 PrePaid：包年包月。	PrePaid
CommodityCode	string	商品 code。枚举值： hologram_maxcomputeAccelerate_public_cn：中国站/湖仓加速。 hologram_combo_public_cn：中国站 / 预付费/包年包月。 hologram_prepay_public_intl：国际站/预付费/包年包月。 hologram_storage_dp_cn：中国站/存储抵扣包。 hologram_postpay_public_cn：中国站/后付费/按量付费。 hologram_postpay_public_intl：国际站/后付费/按量付费。 hologram_maxcomputeAccelerate_public_intl：国际站/湖仓加速。 hologram_cu_dp_cn：中国站/计算抵扣包。	hologram_combo_public_cn
Cpu	long	CPU 核数。	32
CreationTime	string	创建时间。	2021-02-03T13:06:06Z
Disk	string	标准存储大小。单位：GB。	500
Endpoints	object []	域名列表。
Endpoint	string	域名。	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
Type	string	网络类型。枚举值： VPCSingleTunnel：专有网络。 Intranet：内网。 VPCAnyTunnel：（新实例不支持）。 Internet：公网。	Internet
Enabled	boolean	是否开启网络。枚举值： true：开启。 false：关闭。	true
VSwitchId	string	虚拟交换机 ID。	vsw-bp1jqwp2ys6kp7tc9t983
VpcId	string	VPC ID。	vpc-uf66jjber3hgvwhki3wna
VpcInstanceId	string	vpc 实例 ID。	hgprecn-cn-uqm362o1b001-frontend-st
AlternativeEndpoints	string	一些旧实例同时开启了 AnyTunnel 和 SingleTunnel，当从 AnyTunnel 切换到 SingleTunnel 时，会同时保留二者的 Endpoint，因此需要多一个字段保存 Endpoint。	hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
ExpirationTime	string	到期时间。按量付费类型没有到期时间。	2021-02-03T13:06:06Z
InstanceId	string	实例 ID。	hgpostcn-cn-tl32s6cgw00b
InstanceName	string	实例名称。 2-64 个字符，字母和汉字都算一个。	test
InstanceType	string	实例类型。枚举值： Follower：只读从实例。 Standard：普通型。	Standard
Memory	long	内存。单位：GB	128
InstanceOwner	string	实例所有者。	12345678900000
InstanceStatus	string	实例状态。枚举值： Creating：正在创建。 Running：正常运行。 Suspended：停机。 Allocating：正在处理。	Running
Version	string	实例版本。	r1.3.37
SuspendReason	string	暂停原因。枚举值： Indebet：已欠费。 Manul：手动停机。 Overdue：已到期。	Manual
Tags	object []	实例标签
Key	string	标签键。	tag
Value	string	标签值。	value
LeaderInstanceId	string	主实例 ID。	hgpostcn-cn-i7m2ncd6w002
EnableHiveAccess	string	是否启用数据湖加速。	true
ResourceGroupId	string	资源组 ID。	rg-aekzuq7hpybze2i
ComputeNodeCount	long	计算节点数量。一个节点的典型配置：16 核 32G 内存。	2
ZoneId	string	可用区 ID	cn-hangzhou-h
ColdStorage	long	冷存储容量。单位：GB。 SSD 相当于热存，也是标准存储；HDD 相当于冷存。	800
AutoRenewal	string	是否开启了自动续费。枚举值： true：已开启自动续费。 false：未开启自动续费。	true
GatewayCount	long	网关节点数量。	2
GatewayCpu	long	网关 cpu 资源。单位：core。	4
GatewayMemory	long	网关内存资源。单位：GB。	16
RegionId	string	地域 ID。	cn-hangzhou
Success	boolean	请求结果，表示此次请求是否发生异常，和业务无关。	true
ErrorCode	string	错误码。	null
ErrorMessage	string	错误信息。	null
HttpStatusCode	string	HTTP 状态码。	200

示例

正常返回示例

JSON格式

{
  "RequestId": "865A02C2-B374-5DD4-9B34-0CA15DA1AEBD",
  "Instance": {
    "InstanceChargeType": "PrePaid",
    "CommodityCode": "hologram_combo_public_cn",
    "Cpu": 32,
    "CreationTime": "2021-02-03T13:06:06Z",
    "Disk": "500",
    "Endpoints": [
      {
        "Endpoint": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80",
        "Type": "Internet",
        "Enabled": true,
        "VSwitchId": "vsw-bp1jqwp2ys6kp7tc9t983",
        "VpcId": "vpc-uf66jjber3hgvwhki3wna",
        "VpcInstanceId": "hgprecn-cn-uqm362o1b001-frontend-st",
        "AlternativeEndpoints": "hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80"
      }
    ],
    "ExpirationTime": "2021-02-03T13:06:06Z",
    "InstanceId": "hgpostcn-cn-tl32s6cgw00b",
    "InstanceName": "test",
    "InstanceType": "Standard",
    "Memory": 128,
    "InstanceOwner": "12345678900000",
    "InstanceStatus": "Running",
    "Version": "r1.3.37",
    "SuspendReason": "Manual",
    "Tags": [
      {
        "Key": "tag",
        "Value": "value"
      }
    ],
    "LeaderInstanceId": "hgpostcn-cn-i7m2ncd6w002",
    "EnableHiveAccess": "true",
    "ResourceGroupId": "rg-aekzuq7hpybze2i",
    "ComputeNodeCount": 2,
    "ZoneId": "cn-hangzhou-h",
    "ColdStorage": 800,
    "AutoRenewal": "true",
    "GatewayCount": 2,
    "GatewayCpu": 4,
    "GatewayMemory": 16,
    "RegionId": "cn-hangzhou",
    "ReplicaRole": ""
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2024-01-23

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-07-19

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-05-17

OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	删除入参：RegionId
出参	OpenAPI 返回结构发生变更。

2023-04-10

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。