文档

GetInstance - 获取实例详情

更新时间:

获取实例详情。

调试

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

授权信息

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

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

请求语法

GET /api/v1/instances/{instanceId}

请求参数

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

实例 ID。该参数必填。

hgprecn-cn-i7m2v08uu00a

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

865A02C2-B374-5DD4-9B34-0CA15DA1AEBD
Instanceobject

实例信息。

InstanceChargeTypestring

实例付费类型。

枚举值:
  • PostPaid按量付费
  • PrePaid包年包月
PrePaid
CommodityCodestring

商品 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
Cpulong

CPU 核数。

32
CreationTimestring

创建时间。

2021-02-03T13:06:06Z
Diskstring

标准存储大小。 单位:GB。

500
Endpointsobject []

域名列表。

Endpointstring

域名。

hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
Typestring

网络类型。

枚举值:
  • VPCSingleTunnel专有网络
  • Intranet内网
  • VPCAnyTunnel(新实例不支持)
  • Internet公网
Internet
Enabledboolean

是否开启网络。

枚举值:
  • true开启
  • false关闭
true
VSwitchIdstring

虚拟交换机 ID。

vsw-bp1jqwp2ys6kp7tc9t983
VpcIdstring

VPC ID。

vpc-uf66jjber3hgvwhki3wna
VpcInstanceIdstring

vpc 实例 ID。

hgprecn-cn-uqm362o1b001-frontend-st
AlternativeEndpointsstring

一些旧实例同时开启了 AnyTunnel 和 SingleTunnel,当从 AnyTunnel 切换到 SingleTunnel 时,会同时保留二者的 Endpoint,因此需要多一个字段保存 Endpoint。

hgprecn-cn-uqm362o1b001-cn-hangzhou-internal.hologres.aliyuncs.com:80
ExpirationTimestring

到期时间。 按量付费类型没有到期时间。

2021-02-03T13:06:06Z
InstanceIdstring

实例 ID。

hgpostcn-cn-tl32s6cgw00b
InstanceNamestring

实例名称。 2-64 个字符,字母和汉字都算一个。

test
InstanceTypestring

实例类型。

枚举值:
  • Follower只读从实例
  • Standard普通型
Standard
Memorylong

内存。 单位:GB

128
InstanceOwnerstring

实例所有者。

12345678900000
InstanceStatusstring

实例状态。

枚举值:
  • Creating正在创建
  • Running正常运行
  • Suspended停机
  • Allocating正在处理
Running
Versionstring

实例版本。

r1.3.37
SuspendReasonstring

暂停原因。

枚举值:
  • Indebet已欠费
  • Manul手动停机
  • Overdue已到期
Manual
Tagsobject []

实例标签

Keystring

标签键。

tag
Valuestring

标签值。

value
LeaderInstanceIdstring

主实例 ID。

hgpostcn-cn-i7m2ncd6w002
EnableHiveAccessstring

是否启用数据湖加速。

true
ResourceGroupIdstring

资源组 ID。

rg-aekzuq7hpybze2i
ComputeNodeCountlong

计算节点数量。 一个节点的典型配置:16 核 32G 内存。

2
ZoneIdstring

可用区 ID

cn-hangzhou-h
ColdStoragelong

冷存储容量。 单位:GB。 SSD 相当于热存,也是标准存储;HDD 相当于冷存。

800
AutoRenewalstring

是否开启了自动续费。

枚举值:
  • true已开启自动续费
  • false未开启自动续费
true
GatewayCountlong

网关节点数量。

2
GatewayCpulong

网关 cpu 资源。 单位:core。

4
GatewayMemorylong

网关内存资源。 单位:GB。

16
RegionIdstring

地域 ID。

cn-hangzhou
Successboolean

请求结果,表示此次请求是否发生异常,和业务无关。

true
ErrorCodestring

错误码。

null
ErrorMessagestring

错误信息。

null
HttpStatusCodestring

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-23OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-17OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:RegionId
出参OpenAPI 返回结构发生变更
2023-04-10OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)