GetInstance - 擷取執行個體詳情 - Hologres

該介面用於擷取執行個體詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hologram:GetInstance

get

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

無

請求文法

GET /api/v1/instances/{instanceId} HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
instanceId	string	否	執行個體 ID。該參數必填。	hgprecn-cn-i7m2v08uu00a

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱	類型	描述	樣本值
	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	integer	CPU 核心數。	32
CreationTime	string	建立時間。	2021-02-03T13:06:06Z
Disk	string	標準儲存大小。單位：GB。	500
Endpoints	array<object>	網域名稱列表。
	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	執行個體類型。枚舉值： Warehouse : 計算群組型 Follower : 唯讀從執行個體 Standard : 普通型 Serverless : Serverless 型 Shared : 共用型	Standard
Memory	integer	記憶體。單位：GB	128
InstanceOwner	string	執行個體所有者。	12345678900000
InstanceStatus	string	執行個體狀態。枚舉值： Creating : 正在建立 Running : 正常運行 Suspended : 停機 Allocating : 正在處理	Running
Version	string	執行個體版本。	r1.3.37
SuspendReason	string	暫停原因。枚舉值： Indebet : 已欠費 Manual : 手動停機 Overdue : 已到期	Manual
Tags	array<object>	執行個體標籤
	object	標題詳情。
Key	string	標籤鍵。	tag
Value	string	標籤值。	value
LeaderInstanceId	string	主執行個體 ID。	hgpostcn-cn-i7m2ncd6w002
EnableHiveAccess	string	是否啟用資料湖加速。	true
ResourceGroupId	string	資源群組 ID。	rg-aekzuq7hpybze2i
ComputeNodeCount	integer	計算節點數量。一個節點的典型配置：16 核 32G 記憶體。	2
ZoneId	string	可用性區域 ID	cn-hangzhou-h
ColdStorage	integer	冷儲存容量。單位：GB。 SSD 相當於熱存，也是標準儲存；HDD 相當於冷存。	800
AutoRenewal	string	是否開啟了自動續約。枚舉值： true : 已開啟自動續約 false : 未開啟自動續約	true
GatewayCount	integer	網關節點數量。	2
GatewayCpu	integer	網關 cpu 資源。單位：core。	4
GatewayMemory	integer	網關記憶體資源。單位：GB。	16
RegionId	string	地區 ID。	cn-hangzhou
ReplicaRole	string	災備執行個體角色。 Active: 災備主執行個體， Passive: 災備容災執行個體， PreActive: 未達終態的災備主執行個體。	Active
EnableServerless	boolean	是否開啟 ServerlessComputing 枚舉值： true : 已開啟 false : 已關閉	true
StorageType	string	儲存類型： redundant：3AZ local：1AZ	redundant
EnableSSL	boolean
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": "Active",
    "EnableServerless": true,
    "StorageType": "redundant",
    "EnableSSL": true
  },
  "Success": true,
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。