CreateInstance - 建立叢集

更新時間:
Copy as MD

建立一個 OceanBase 資料庫叢集。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:CreateInstance

create

*Instance

acs:oceanbase:{#regionId}:{#accountId}:instance/*

請求參數

名稱

類型

必填

描述

樣本值

ChargeType

string

執行個體的付費方式。取值範圍:

  • PrePay:訂用帳戶。選擇該類付費方式時,必須確認自己的帳號支援餘額支付 / 信用支付,否則將返回 InvalidPayMethod 的錯誤提示。

  • PostPay(預設):隨用隨付(預設按小時計費)。

枚舉值:

  • PrePay :

    PrePay

  • PostPay :

    PostPay

PrePay

Series

string

執行個體的系列。

  • normal(預設):標準叢集版(雲端硬碟)。

  • normal_ssd:標準叢集版(本地碟)。

  • history:歷史庫叢集版。

  • normal_kv:obkv 叢集。

  • normal_hg:信創叢集(需要添加白名單開放)。

normal

Zones

string

執行個體所屬的可用性區域 ID。
輸入多個可用性區域時注意以逗號分隔。 更多詳情,請參見 DescribeZones 擷取可用性區域列表。

cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j

InstanceClass

string

叢集規格資訊。
當前支援以下套餐:

  • 4C16GB:4 核 16GB。

  • 8C32GB:8 核 32GB。

  • 14C70GB:14 核 70GB。

  • 24C120GB:24 核 120GB。

  • 30C180GB:30 核 180GB。

  • 62C400GB:62 核 400GB。

  • 104C600GB:104 核 600GB。

  • 16C70GB:16 核 70GB。

  • 32C160GB:32 核 160GB。

  • 64C380GB:64 核 380GB。

  • 20C32GB:20 核 32GB。

  • 40C64GB:40 核 64GB。

  • 16C32GB:16 核 32GB。

  • 32C70GB:32 核 70GB。

  • 64C180GB:64 核 180GB。

  • 32C180GB:32 核 180GB。

  • 64C400GB:64 核 400GB。

枚舉值:

  • 64C380GB :

    64 核 380GB

  • 64C400GB :

    64 核 400GB

  • 32C70GB :

    32 核 70GB

  • 14C70GB :

    14 核 70GB

  • 16C32GB :

    16 核 32GB

  • 4C16GB :

    4 核 16GB

  • 32C160GB :

    32 核 160GB

  • 8C32GB :

    8 核 32GB

  • 16C70GB :

    16 核 70GB

  • 24C120GB :

    24 核 120GB

  • 32C180GB :

    32 核 180GB

  • 30C180GB :

    30 核 180GB

  • 40C64GB :

    40 核 64GB

  • 62C400GB :

    62 核 400GB

  • 20C32GB :

    20 核 32GB

  • 104C600GB :

    104 核 600GB

  • 64C180GB :

    64 核 180GB

14C70GB

DiskSize

integer

儲存空間大小,單位 GB。 儲存空間的限制根據叢集規格不同而不同,具體如下:

  • 8C32GB:100GB~10000GB。

  • 14C70GB:200GB~10000GB。

  • 30C180GB:400GB~10000GB。

  • 62C400G:800GB-10000GB。 各套餐的儲存空間預設值為其最小值。

200

Period

integer

購買資源的時間長度,單位由 PeriodUnit 指定。
當參數 InstanceChargeType 取值為 PrePaid 時才生效且為必選值。 取值範圍:

  • PeriodUnit=Month 時,Period 取值:{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”}。

  • PeriodUnit=Year 時,Period 取值:{“1”, “2”, “3”}。

1

PeriodUnit

string

購買資源的時間長度。
訂用帳戶取值範圍:Month 或者 Year。
預設值:訂用帳戶為 Month,隨用隨付,預設周期為 Hour。

Month

AutoRenew

boolean

是否要自動續約。 當參數 ChargeType 取值 PrePaid 時生效。取值範圍:

  • true:自動續約。

  • false(預設):不自動續約。

true

AutoRenewPeriod

integer

每次自動續約的時間長度,當參數 AutoRenew 取值 True 時,該參數為必填參數。

  • PeriodUnit 為 Year 時,AutoRenewPeriod 取值範圍為 {"1", "2", "3"}。

  • PeriodUnit 為 Month 時,AutoRenewPeriod 取值範圍為 {"1", "2", "3", "6", "12"}。

2

ResourceGroupId

string

執行個體所在的企業資源組 ID。

rg-bp67acfmxazb4p****

InstanceName

string

OceanBase 叢集名稱。 長度為 1~20 個英文或中文字元。 如未指定該參數,預設值為叢集的 InstanceId。

amap_aos_tx_ob

ObVersion

string

OceanBase Server 版本號碼。

2.2.77

DiskType

string

叢集的儲存類型。僅在標準叢集版(雲端硬碟)下生效。
當前支援兩種類型:

  • cloud_essd_pl1:雲端硬碟 ESSD PL1。

  • cloud_essd_pl0:雲端硬碟 ESSD PL0。預設值為 cloud_essd_pl1。

cloud_essd_pl1

DryRun

boolean

是否只預檢此次請求, 預設為 false。取值範圍:

  • true:發送檢查請求,不會建立執行個體。如果檢查通過,則返回 DryRunResult=true, 如果檢查不通過,則返回相應錯誤的錯誤碼。

  • false(預設):發送正常請求,通過檢查後直接建立執行個體。如為 false, 則表示不進行預檢查, DryRunResult 預設返回 false。

false

ReplicaMode

string

全功能型副本數。傳回值僅包含 3 和 2。

  • 3:表示 3 個全功能型副本。

  • 2:表示 2 個全功能型副本。 三可用性區域部署時,只支援 3 個全功能型副本,雙可用性區域部署時,僅支援 2 個全功能型副本,單可用性區域部署時,可以支援 2 個或者 3 個全功能型副本。

3

IsolationOptimization

string

是否開啟 Cgroup。

true

PrimaryInstance

string

主執行個體 ID。

ob3h8ytroxxxxx

PrimaryRegion

string

主執行個體 Region。

cn-hangzhou

CpuArch

string

cpu 架構

x86

返回參數

名稱

類型

描述

樣本值

object

請求結果。

RequestId

string

請求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C

Data

object

返回資料。

InstanceId

string

執行個體 ID。

i-bp67acfmxazb4p****

OrderId

string

訂單 ID。
該參數在建立預付費和後付費叢集時包含傳回值。

1234567890

ResourceGroupId

string

資源群組 ID。

rg-***************

DryRunResult

boolean

預檢查請求的結果。

  • 如果 DryRun 填寫為 true,當預檢查請求通過,則 DryRunResult 返回 true,否則返回相應的錯誤碼資訊。

  • 如果 DryRun 填寫為 false, 則表示不進行預檢查, DryRunResult 預設返回 false。

false

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "InstanceId": "i-bp67acfmxazb4p****",
    "OrderId": "1234567890",
    "ResourceGroupId": "rg-***************",
    "DryRunResult": false
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 Instance.Order.CreateFailed Instance.Order.CreateFailed
400 InstanceName.ModifyFailed InstanceName.ModifyFailed
400 InstanceClass.InvalidValue InstanceClass.InvalidValue
400 InstanceType.Unsupport InstanceType.Unsupport
400 ZoneList.Unsupport ZoneList.Unsupport
400 InstanceId.Invalid InstanceId.Invalid
400 InstanceId.Missing InstanceId.Missing
400 Instance.Name.Missing Instance.Name.Missing
400 ListCluster.Fail ListCluster.Fail
400 GetCluster.Fail GetCluster.Fail
400 ListClusterGroup.Fail ListClusterGroup.Fail
400 GetClusterGroup.Fail GetClusterGroup.Fail
400 ListInstance.Fail ListInstance.Fail
400 GetInstance.Fail GetInstance.Fail
400 ListTenant.Fail ListTenant.Fail
400 GetTenant.Fail GetTenant.Fail
400 Instance.ListAliyunInstance.Fail Instance.ListAliyunInstance.Fail
400 Instance.GetAliyunInstance.Fail Instance.GetAliyunInstance.Fail
400 ListZone.Fail ListZone.Fail
400 ListObServer.Fail ListObServer.Fail
400 GetObServer.Fail GetObServer.Fail
400 CreateInstanceParameters.Error CreateInstanceParameters.Error
400 CreateInstance.Fail CreateInstance.Fail
400 InstanceClassSpecification.Invalid InstanceClassSpecification.Invalid
400 InstanceOrder.NotAvailable InstanceOrder.NotAvailable
400 InstanceNodeNum.Invalid InstanceNodeNum.Invalid
400 InstanceLogSize.Invalid InstanceLogSize.Invalid
400 Instance.ExpandLogDisk.NotSupport Instance.ExpandLogDisk.NotSupport
400 InstanceStatus.Invalid InstanceStatus.Invalid
400 InstanceDataSize.Invalid InstanceDataSize.Invalid
400 StandbyInstance.StillOnline StandbyInstance.StillOnline
400 InstanceServiceName.Missing InstanceServiceName.Missing
400 PrimaryInstanceStatus.Invalid PrimaryInstanceStatus.Invalid
400 StandbyInstanceStatus.Invalid StandbyInstanceStatus.Invalid
400 StandbyInstance.NotSupport StandbyInstance.NotSupport
400 StandbyInstance.Disconnect.NotAllowed StandbyInstance.Disconnect.NotAllowed
400 InstanceDiskSize.Invalid InstanceDiskSize.Invalid
400 CreateInstance.Spec.NotSupport CreateInstance.Spec.NotSupport
400 MissingParameterDiskSize MissingParameterDiskSize
400 CreateInstance.ReplicaMode.InvalidValue CreateInstance.ReplicaMode.InvalidValue
400 CreateInstance.DeployType.InvalidValue CreateInstance.DeployType.InvalidValue
400 ConfigError ConfigError
500 Instance.Order.CreateFailed Instance.Order.CreateFailed
500 UnknownError UnknownError

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

變更歷史

更多資訊,參考變更詳情