すべてのプロダクト
Search

このプロダクト

    ApsaraDB for ClickHouse:CreateDBInstance

    ドキュメントセンター

    ApsaraDB for ClickHouse:CreateDBInstance

    最終更新日:Apr 08, 2026

    Alibaba Cloud ClickHouse クラスターを作成します。

    操作説明

    この API を呼び出す前に、ApsaraDB for ClickHouse の課金方法と価格を理解していることを確認してください。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    clickhouse:CreateDBInstance

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions API を呼び出して、最新のリージョンリストを照会できます。

    cn-hangzhou
    ZoneId

    string

    任意

    アベイラビリティゾーン ID。 DescribeRegions API を呼び出して、最新のアベイラビリティゾーンリストを照会できます。

    cn-hangzhou-h
    DBClusterVersion

    string

    必須

    エンジンバージョン。 有効値：

    • 21.8.10.19

    • 22.8.5.29

    列挙値:

    • 22.8.5.29 :

      22.8.5.29

    • 21.8.10.19 :

      21.8.10.19

    22.8.5.29
    DBClusterCategory

    string

    必須

    レプリカ構成。 有効値：

    • Basic：シングルレプリカ

    • HighAvailability：高可用性 (デュアルレプリカ)

    列挙値:

    • Basic :

      Basic

    • HighAvailability :

      HighAvailability

    Basic
    DBClusterClass

    string

    必須

    インスタンスタイプ。

    • シングルレプリカクラスターの場合、有効値は次のとおりです。

      • LS20：大容量ストレージ、20 コア、88 GB

      • LS40：大容量ストレージ、40 コア、176 GB

      • LS80：大容量ストレージ、80 コア、352 GB

      • S8：標準、8 コア、32 GB

      • S16：標準、16 コア、64 GB

      • S32：標準、32 コア、128 GB

      • S64：標準、64 コア、256 GB

      • S80：標準、80 コア、384 GB

      • S104：標準、104 コア、384 GB

    • 高可用性クラスターの場合、有効値は次のとおりです。

      • LC20：大容量ストレージ、20 コア、88 GB

      • LC40：大容量ストレージ、40 コア、176 GB

      • LC80：大容量ストレージ、80 コア、352 GB

      • C8：標準、8 コア、32 GB

      • C16：標準、16 コア、64 GB

      • C32：標準、32 コア、128 GB

      • C64：標準、64 コア、256 GB

      • C80：標準、80 コア、384 GB

      • C104：標準、104 コア、384 GB

    • シングルレプリカクラスターの場合、有効値は次のとおりです。

      • S8：8 コア、32 GB

      • S16：16 コア、64 GB

      • S32：32 コア、128 GB

      • S64：64 コア、256 GB

      • S104：104 コア、384 GB

    • 高可用性クラスターの場合、有効値は次のとおりです。

      • C8：8 コア、32 GB

      • C16：16 コア、64 GB

      • C32：32 コア、128 GB

      • C64：64 コア、256 GB

      • C104：104 コア、384 GB

    S8
    DBNodeGroupCount

    string

    必須

    ノード数。

    • シングルレプリカクラスターの場合、有効範囲は 1～48 です。

    • 高可用性クラスターの場合、有効範囲は 1～24 です。

    1
    DBNodeStorage

    string

    必須

    ノードあたりのストレージ容量 (GB) 。 有効範囲は 100～32,000 です。

    説明

    値は 100 の倍数である必要があります。

    100
    DBClusterNetworkType

    string

    必須

    ネットワークタイプ。 現在、VPC のみがサポートされています。

    VPC
    DBClusterDescription

    string

    任意

    クラスターの説明。

    test
    PayType

    string

    必須

    課金方法。 有効値：

    • Postpaid：従量課金

    • Prepaid：サブスクリプション

    列挙値:

    • Prepaid :

      Prepaid

    • Postpaid :

      Postpaid

    Prepaid
    Period

    string

    任意

    サブスクリプション期間の単位。

    重要 このパラメーターは、`PayType` が `Prepaid` に設定されている場合にのみ必須です。

    • Year：年単位。

    • Month：月単位。

    Month
    UsedTime

    string

    任意

    サブスクリプション期間。

    重要 このパラメーターは、`PayType` が `Prepaid` に設定されている場合にのみ必須です。

    • `Period` が `Year` の場合、有効範囲は 1～3 です。

    • `Period` が `Month` の場合、有効範囲は 1～9 です。

    1
    VPCId

    string

    必須

    VPC ID。

    vpc-bp175iuvg8nxqraf2****
    VSwitchId

    string

    必須

    VSwitch ID。

    vsw-bp1gzt31twhlo0sa5****
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。 値は 64 ASCII 文字以下の文字列である必要があります。

    AB
    DbNodeStorageType

    string

    必須

    ストレージタイプ。 有効値：

    • CloudESSD：ESSD PL1 クラウドディスク

    • CloudESSD_PL2：ESSD PL2 クラウドディスク

    • CloudESSD_PL3：ESSD PL3 クラウドディスク

    • CloudEfficiency：高効率クラウドディスク

    CloudESSD_PL2
    EncryptionKey

    string

    任意

    このパラメーターは、`EncryptionType` が `CloudDisk` に設定されている場合に必須です。

    クラウドディスク暗号化キーの ID。 Key Management Service (KMS) コンソールでキーを作成および管理できます。

    説明

    `EncryptionType` が指定されていない場合、このパラメーターを指定する必要はありません。

    0d2470df-da7b-4786-b981-9a164dae****
    EncryptionType

    string

    任意

    暗号化タイプ。 クラウドディスク暗号化のみがサポートされています。 この値を CloudDisk に設定します。

    説明

    このパラメーターを指定しない場合、暗号化は無効になります。

    CloudDisk
    BackupSetID

    string

    任意

    バックアップセットの ID。 DescribeBackups API を呼び出して、バックアップセット ID を照会できます。

    説明

    このパラメーターは、ApsaraDB for ClickHouse クラスターにデータを復元する場合に必須です。

    b-12af23adsf
    SourceDBClusterId

    string

    任意

    ソースクラスターの ID。 DescribeDBClusters API を呼び出して、クラスター ID を照会できます。

    説明

    このパラメーターは、ApsaraDB for ClickHouse クラスターにデータを復元する場合に必須です。

    cc-bp1lxbo89u950****
    ResourceGroupId

    string

    任意

    クラスターを含むリソースグループの ID。

    rg-4690g37929****
    ZoneIdBak

    string

    任意

    セカンダリアベイラビリティゾーンの ID。

    cn-hangzhou-k
    VSwitchBak

    string

    任意

    セカンダリ VSwitch の ID。

    vsw-bp1gzt31twhlo0sa5****
    ZondIdBak2

    string

    任意

    2 番目のスタンバイアベイラビリティゾーンの ID。

    cn-hangzhou-j
    VSwitchBak2

    string

    任意

    2 番目のスタンバイ VSwitch の ID。

    vsw-bp1gzt31twhlo0sa5****
    AutoRenew

    boolean

    任意

    自動更新を有効にするかどうかを指定します。

    説明

    このパラメーターは、`PayType` が `Prepaid` に設定されている場合にのみ適用されます。

    false
    Tags

    array<object>

    任意

    クラスターに追加するタグ。

    object

    任意

    タグ。

    key

    string

    任意

    タグキー。

    user123
    value

    string

    任意

    タグ値。

    示例字符串

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データ。

    RequestId

    string

    リクエストの一意の ID。

    F5178C10-1407-4987-9133-DE4DC9119F75
    DBClusterId

    string

    クラスターの ID。

    cc-bp1qx68m06981****
    OrderId

    string

    注文の ID。

    21137950671****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "DBClusterId": "cc-bp1qx68m06981****",
  "OrderId": "21137950671****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError An error occurred while processing your request. An error occurred while processing your request.
    503 ServiceUnavailable An error occurred while processing your request. An error occurred while processing your request.

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

    変更履歴

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