該接口用于創建Hologres實例。
接口說明
警告 該 API 操作涉及費用，請確保在使用該接口前，已充分了解實時數倉 Hologres 的收費方式和價格。
-
Hologres 計費詳情請參見計費概述。
-
創建 Hologres 實例時，您需要指定實例所在地域和可用區。一個地域可能對應多個可用區，具體如下：
cn-hangzhou(杭州)：cn-hangzhou-h, cn-hangzhou-j
cn-shanghai(上海): cn-shanghai-e, cn-shanghai-f
cn-beijing(北京): cn-beijing-i, cn-beijing-g
cn-zhangjiakou(張家口): cn-zhangjiakou-b
cn-shenzhen(深圳): cn-shenzhen-d, cn-shenzhen-f, cn-shenzhen-e
cn-hongkong(香港): cn-hongkong-b
cn-shanghai-finance-1(上海金融云): cn-shanghai-finance-1z
ap-northeast-1(日本): ap-northeast-1a
ap-southeast-1(新加坡): ap-southeast-1c
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 | 是 | 虛擬專有網絡，其所在 regionId 必須與實例一致。 | vpc-t4netc3y5xxxx |
| vSwitchId | string | 是 | 虛擬專有交換機，其所在 zoneId 必須與實例一致。 | vsw-2vccsiymtxxxxxx |
| resourceGroupId | string | 否 | 資源組。若為空，則為賬號默認資源組。 | "" |
| instanceName | string | 是 | 實例名稱(2-64 個字符，一個中文/字母算一個字符)。 | my_holo |
| instanceType | string | 是 | 實例類型。取值：
| Standard |
| cpu | long | 否 | 實例規格。取值：
說明
| 64 |
| storageSize | long | 否 | 實例標準存儲空間。單位：GB。 說明
按量付費實例（PostPaid）會忽略此參數。
| 500 |
| coldStorageSize | long | 否 | 實例低頻存儲空間。單位：GB。 說明
按量付費（PostPaid）實例會忽略此參數。
| 500 |
| gatewayCount | long | 否 | 網關數量，取值[2, 50]。 說明
只有 Warehouse 類型需要指定該參數。
| 4 |
| chargeType | string | 是 | 付費類型。取值：
說明
Shared 實例類型會忽略該參數。Shared 是一種固定規格類型，收費類型默認為 PostPaid。
| PostPaid |
| autoPay | boolean | 否 | 是否自動支付，默認為 true。取值：
說明
默認值為 true。如果您的支付方式余額不足，可以將參數 AutoPay 設置為 false，此時會生成未支付訂單，您可以登錄費用與成本自行支付。
| true |
| pricingCycle | string | 否 | 計費周期。取值：
說明
| Month |
| duration | long | 否 | 購買周期。比如購買 2 個月。 說明
若付費類型為 PostPaid，則無需指定。
| 2 |
| autoRenew | boolean | 否 | 是否開啟按月自動續費，默認值為 false。取值：
| false |
| leaderInstanceId | string | 否 | 主實例 Id，Follower 類型必填。 說明
主從實例必須滿足以下條件：
| hgpostcn-cn-lbj3aworq112 |
| initialDatabases | string | 否 | 初始數據庫。 | chatbot |
| enableServerlessComputing | boolean | 否 | 是否開啟 ServerlessComputing 枚舉值：
| true |
返回參數
說明
參數校驗錯誤，仍然會返回正常的 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": "專有網絡或交換機不可用",
"Success": "true"
},
"HttpStatusCode": "200",
"ErrorMessage": "null",
"ErrorCode": "null"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-04-10 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2023-10-18 | API 內部配置變更，不影響調用 | 查看變更詳情 |
| 2023-07-19 | API 內部配置變更，不影響調用 | 查看變更詳情 |