CreateInstance - 建立執行個體 - Hologres

該介面用於建立執行個體。

介面說明

警告該 API 操作涉及費用，請確保在使用該介面前，已充分瞭解即時數倉 Hologres 的收費方式和價格。

Hologres 計費詳情請參見計費概述。
建立 Hologres 執行個體時，您需要指定執行個體所在地區和可用性區域。一個地區可能對應多個可用性區域，具體如下：

   cn-hangzhou(杭州)：cn-hangzhou-h, cn-hangzhou-j, cn-hangzhou-k
   cn-shanghai(上海): cn-shanghai-e, cn-shanghai-f, cn-shanghai-l
   cn-beijing(北京): cn-beijing-i, cn-beijing-g, cn-beijing-l
   cn-zhangjiakou(張家口): cn-zhangjiakou-b
   cn-shenzhen(深圳): cn-shenzhen-d, cn-shenzhen-f, cn-shenzhen-e
   cn-wulanchabu(烏蘭察布): cn-wulanchabu-a
   cn-hongkong(香港): cn-hongkong-b, cn-hongkong-d
   cn-shanghai-finance-1(上海金融雲): cn-shanghai-finance-1z, cn-shanghai-finance-1f
   cn-hangzhou-finance(杭州金融雲): cn-hangzhou-finance-k
   cn-shenzhen-finance-1(深圳金融雲): cn-shenzhen-finance-1d
   ap-northeast-1(日本): ap-northeast-1a
   ap-southeast-1(新加坡): ap-southeast-1c, ap-southeast-1a
   ap-southeast-3(吉隆坡): ap-southeast-3b
   ap-southeast-5(雅加達): ap-southeast-5b
   eu-central-1(法蘭克福): eu-central-1a
   us-east-1(矽谷): us-east-1a
   us-west-1(維吉尼亞): us-west-1b

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hologram:CreateInstance

create

*全部資源

*

無

請求文法

POST /api/v1/instances/create HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
body	object	否	請求體。
regionId	string	是	地區 Id. 可前往服務存取點。	cn-hangzhou
zoneId	string	是	可用性區域 Id。參考“使用說明“	cn-hangzhou-h
vpcId	string	是	Virtual Private Cloud絡，其所在 regionId 必須與執行個體一致。	vpc-t4netc3y5xxxx
vSwitchId	string	是	虛擬專有交換器，其所在 zoneId 必須與執行個體一致。	vsw-2vccsiymtxxxxxx
resourceGroupId	string	否	資源群組。若為空白，則為帳號預設資源群組。	""
instanceName	string	是	執行個體名稱(2-64 個字元，一個中文/字母算一個字元)。	my_holo
instanceType	string	是	執行個體類型。取值： Standard：通用型。 Follower：唯讀從執行個體。 Warehouse：計算群組型。 Shared：共用型。 Severless：Serverless 型枚舉值： Warehouse : Warehouse Follower : Follower Standard : Standard Serverless : Serverless Shared : Shared	Standard
cpu	integer	否	執行個體規格。取值： 32 核 128 GB（計算節點數量：2） 64 核 256 GB（計算節點數量：4） 96 核 384 GB（計算節點數量：6） 128 核 512 GB（計算節點數量：8）等說明填寫核心數即可。購買 1024 以上規格執行個體請提交工單申請。 Shared 執行個體類型無需指定規格。	64
storageSize	integer	否	執行個體標準儲存空間。單位：GB。說明隨用隨付執行個體（PostPaid）會忽略此參數。	500
coldStorageSize	integer	否	執行個體低頻儲存空間。單位：GB。說明隨用隨付（PostPaid）執行個體會忽略此參數。	500
gatewayCount	integer	否	網關數量，取值[2, 50]。說明只有 Warehouse 類型需要指定該參數。	4
chargeType	string	是	付費類型。取值： PrePaid：訂用帳戶。 PostPaid: 隨用隨付。說明 Shared 執行個體類型會忽略該參數。Shared 是一種固定規格類型，收費類型預設為 PostPaid。枚舉值： PostPaid : PostPaid PrePaid : PrePaid	PostPaid
autoPay	boolean	否	是否自動支付，預設為 true。取值： true：自動支付。 false：只產生訂單，不支付。說明預設值為 true。如果您的支付方式餘額不足，可以將參數 AutoPay 設定為 false，此時會產生未支付訂單，您可以登入費用與成本自行支付。	true
pricingCycle	string	否	計費周期。取值： Month：按月計費。 Hour：按小時計費。說明 PrePaid 只支援 Month PostPaid 只支援 Hour Shared 類型自動設為 Hour，無需指定。枚舉值： Month : Month Hour : Hour	Month
duration	integer	否	購買周期。比如購買 2 個月。說明若付費類型為 PostPaid，則無需指定。	2
autoRenew	boolean	否	是否開啟按月自動續約，預設值為 false。取值： true：開啟。 false：不開啟。	false
leaderInstanceId	string	否	主執行個體 Id，Follower 類型必填。說明主從執行個體必須滿足以下條件：主執行個體"運行正常"(Running)狀態主從執行個體 regionId 一致主從執行個體 zoneId 一致主執行個體已綁定的從執行個體數少於 10 個主從執行個體屬於同一個主帳號	hgpostcn-cn-lbj3aworq112
initialDatabases	string	否	初始資料庫。	chatbot
enableServerlessComputing	boolean	否	是否開啟 ServerlessComputing 枚舉值： true : 開啟 false : 不開啟	true
storageType	string	否	儲存類型枚舉值： local : 本地冗餘類型 redundant : 同城冗餘(多 AZ)	redundant

返回參數

名稱	類型	描述	樣本值
	object	返回參數詳情。
RequestId	string	請求 ID。	9CC37B9F-F4B4-5FF1-939B-AEE78DC70130
Data	object	返回結果。
InstanceId	string	執行個體 ID。	hgpostcn-cn-xxxxxx
OrderId	string	訂單 ID。	217523224780172
Code	string	錯誤碼。	InvalidVpcOrVSwitch.NotAvailable
Message	string	錯誤詳細資料。	InvalidVpcOrVSwitch.NotAvailable
Success	string	建立是否成功。 true：建立成功。 false：建立失敗。	true
HttpStatusCode	string	http 狀態代碼	200
ErrorMessage	string	錯誤資訊。	null
ErrorCode	string	錯誤碼。	null

說明

參數校正錯誤，仍然會返回正常的 Data，Success 為 false，並包含 Code 和 Message。除非拋出異常，否則成功與否由 Data.Success 來判斷。
使用新版 SDK 包調用本介面時，由於 SDK 內部的用戶端預設逾時時間和服務端的不一致，因此可能返回請求逾時的錯誤，但實際上介面已調用成功。如需避免這個問題，您可以在調用前設定 ReadTimeout 參數為 20000。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9CC37B9F-F4B4-5FF1-939B-AEE78DC70130",
  "Data": {
    "InstanceId": "hgpostcn-cn-xxxxxx",
    "OrderId": "217523224780172",
    "Code": "InvalidVpcOrVSwitch.NotAvailable",
    "Message": "InvalidVpcOrVSwitch.NotAvailable\n",
    "Success": "true"
  },
  "HttpStatusCode": "200",
  "ErrorMessage": "null",
  "ErrorCode": "null"
}

錯誤碼

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

變更歷史

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