すべてのプロダクト
Search

このプロダクト

    ApsaraDB for OceanBase (Deprecated):CreateInstance

    ドキュメントセンター

    ApsaraDB for OceanBase (Deprecated):CreateInstance

    最終更新日:May 26, 2026

    OceanBase データベースクラスターを作成します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    oceanbase:CreateInstance

    create

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ChargeType

    string

    必須

    インスタンスの課金方法。有効な値：

    • PrePay: サブスクリプション (年額/月額) 課金です。アカウントの残高またはクレジット残高がサブスクリプションのコストをカバーできることを確認する必要があります。そうでない場合、InvalidPayMethod エラーが返されます。

    • PostPay: 従量課金です。これがデフォルト値です。デフォルトでは、1 時間単位で料金が請求されます。

    列挙値:

    • PrePay :

      PrePay

    • PostPay :

      PostPay

    PrePay
    Series

    string

    必須

    OceanBase クラスターのシリーズ。有効な値：

    • normal: 標準クラスター版 (クラウドディスク)。これがデフォルト値です。

    • normal_ssd: 標準クラスター版 (ローカルディスク)。

    • history: 履歴データベースクラスター版。

    normal
    Zones

    string

    必須

    インスタンスが属するゾーンの ID。
    ゾーンのリストを取得する方法の詳細については、「DescribeZones」をご参照ください。

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

    string

    必須

    インスタンスの仕様。
    以下の 4 つのプランから選択します。

    • 8C32GB: 8 CPU コア、32 GB メモリ。

    • 14C70GB: 14 CPU コア、70 GB メモリ。これがデフォルト値です。

    • 30C180GB: 30 CPU コア、180 GB メモリ。

    • 62C400GB: 62 CPU コア、400 GB メモリ。

    列挙値:

    • 64C380GB :

      64C380GB

    • 64C400GB :

      64C400GB

    • 32C70GB :

      32C70GB

    • 14C70GB :

      14C70GB

    • 16C32GB :

      16C32GB

    • 4C16GB :

      4C16GB

    • 32C160GB :

      32C160GB

    • 8C32GB :

      8C32GB

    • 16C70GB :

      16C70GB

    • 24C120GB :

      24C120GB

    • 32C180GB :

      32C180GB

    • 30C180GB :

      30C180GB

    • 40C64GB :

      40C64GB

    • 62C400GB :

      62C400GB

    • 20C32GB :

      20C32GB

    • 104C600GB :

      104C600GB

    • 64C180GB :

      64C180GB

    14C70GB
    DiskSize

    integer

    任意

    ストレージ容量 (単位: GB)。
    ストレージ容量の制限は、インスタンスの仕様によって異なります。

    • 8C32GB: 100 GB～10000 GB

    • 14C70GB: 200 GB～10000 GB

    • 30C180GB: 400 GB～10000 GB

    • 62C400GB: 800 GB～10000 GB
      上記の最小ストレージ容量は、各仕様のデフォルト値です。

    200
    Period

    integer

    任意

    購入するリソースの有効期間。単位は PeriodUnit パラメータで指定します。
    このパラメータは、InstanceChargeType パラメータが PrePay に設定されている場合にのみ有効かつ必須です。
    有効な値：

    • PeriodUnit が Month の場合: 1、2、3、4、5、6、7、8、9。

    • PeriodUnit が Year の場合: 1、2、3。

    1
    PeriodUnit

    string

    任意

    購入するリソースの有効期間の単位。
    サブスクリプションの有効な値：Month または Year。 デフォルト値：サブスクリプションの場合は Month、従量課金の場合は Hour。

    Month
    AutoRenew

    boolean

    任意

    自動更新を有効にするかどうかを指定します。
    このパラメータは、InstanceChargeType パラメータが PrePay に設定されている場合にのみ有効です。有効な値：

    • true: インスタンスの自動更新を有効にします。

    • false: インスタンスの自動更新を無効にします。これがデフォルト値です。

    true
    AutoRenewPeriod

    integer

    任意

    インスタンスの自動更新期間。このパラメータは、AutoRenew が true の場合に必須となります。有効な値：

    • PeriodUnit が Year の場合: 1、2、3。

    • PeriodUnit が Month の場合: 1、2、3、6、12。

    2
    ResourceGroupId

    string

    任意

    インスタンスが属するリソースグループの ID。

    rg-bp67acfmxazb4p****
    InstanceName

    string

    任意

    OceanBase クラスターの名前。
    1～20 文字である必要があります。
    このパラメータを指定しない場合、デフォルトでクラスターのインスタンス ID が使用されます。

    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: 実際のリクエストが送信され、ドライランは実行されません。要件を満たしている場合、インスタンスが作成されます。DryRun を false に設定した場合、デフォルトでは DryRunResult パラメータは false を返します。

    false
    ReplicaMode

    string

    任意

    フル機能レプリカの数。

    • 3F: 3 つのフル機能レプリカ。

    • 2F1L: 2 つのフル機能レプリカと 1 つのログレプリカ。

    • 2F1A: 2 つのフル機能レプリカと 1 つの仲裁サービス。

    • ApsaraDB for OceanBase V4.1 より前のバージョンは、3F と 2F1L をサポートしています。

    • ApsaraDB for OceanBase V4.1 以降は、3F と 2F1A をサポートしています。

    • 3 つのゾーンにデプロイされた ApsaraDB for OceanBase インスタンスは、3F のみをサポートしています。

    • 2 つのゾーンにデプロイされた ApsaraDB for OceanBase インスタンスは、バージョンに応じて 2F1A または 2F1L をサポートしています。

    • 単一ゾーンにデプロイされた ApsaraDB for OceanBase インスタンスは、バージョンに応じて 3F、2F1A、または 2F1L をサポートしています。

    3
    IsolationOptimization

    string

    任意

    コントロールグループ機能を有効にするかどうかを指定します。 有効な値：

    • true

    • false

    true
    PrimaryInstance

    string

    任意

    プライマリインスタンスの ID。

    ob3h8ytroxxxxx
    PrimaryRegion

    string

    任意

    プライマリインスタンスのリージョン。

    cn-hangzhou
    CpuArch

    string

    任意

    CPU アーキテクチャ。

    x86

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスオブジェクトです。

    RequestId

    string

    リクエスト ID です。

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

    object

    返されたデータです。

    InstanceId

    string

    インスタンス ID です。

    i-bp67acfmxazb4p****
    OrderId

    string

    注文 ID です。 発注した注文の ID です。このパラメーターには、前払いまたは従量課金のクラスターを作成した後に値が返されます。

    1234567890
    ResourceGroupId

    string

    リソースグループ ID です。

    rg-***************
    DryRunResult

    boolean

    ドライランリクエストの結果です。

    DryRun パラメーターが true に設定され、ドライランが成功した場合、DryRunResult パラメーターには true が返されます。 DryRun パラメーターが false に設定されている場合、ドライランは実行されず、DryRunResult パラメーターには false が返されます。

    false

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。