すべてのプロダクト
Search

このプロダクト

    ApsaraDB for ClickHouse:DescribeDBClusters

    ドキュメントセンター

    ApsaraDB for ClickHouse:DescribeDBClusters

    最終更新日:May 09, 2026

    指定されたリージョンの 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:DescribeDBClusters

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID です。DescribeRegions 操作を呼び出して、リージョン ID を照会できます。

    cn-hangzhou
    DBClusterIds

    string

    任意

    クラスター ID です。

    説明

    このパラメーターを指定しない場合、デフォルトで全クラスターの情報が照会されます。

    cc-bp108z124a8o7****
    DBClusterDescription

    string

    任意

    クラスターの説明です。

    cc-bp108z124a8o7****
    DBClusterStatus

    string

    任意

    クラスターのステータスです。有効値は次のとおりです。

    • Preparing：クラスターを準備中です。

    • Creating：クラスターを作成中です。

    • Running：クラスターが実行中です。

    • Deleting：クラスターを削除中です。

    • SCALING_OUT：クラスターをスケールアウト中です。

    Running
    PageSize

    integer

    任意

    1 ページあたりのエントリ数です。有効値は次のとおりです。

    • 30 (デフォルト)

    • 50

    • 100

    30
    PageNumber

    integer

    任意

    ページ番号です。

    1
    Tag

    array<object>

    任意

    タグです。

    object

    任意

    タグです。

    Key

    string

    任意

    タグのキーです。

    department
    Value

    string

    任意

    タグの値です。

    it
    ResourceGroupId

    string

    任意

    クラスターが属するリソースグループの ID です。

    rg-4690g37929****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    エントリの総数です。

    1
    PageSize

    integer

    1 ページあたりに返されるエントリ数です。有効値は次のとおりです。

    • 30 (デフォルト)

    • 50

    • 100

    30
    RequestId

    string

    リクエスト ID です。

    F5178C10-1407-4987-9133-DE4DC9119F75
    PageNumber

    integer

    ページ番号です。

    1
    DBClusters

    object

    DBCluster

    array<object>

    クラスターリストです。

    array<object>

    クラスターリストです。

    VpcId

    string

    VPC ID です。

    vpc-bp175iuvg8nxqraf2****
    DBNodeCount

    integer

    ノード数です。

    • 単一レプリカエディションのクラスターの場合、値の範囲は 1～48 です。

    • デュアルレプリカエディションのクラスターの場合、値の範囲は 1～24 です。

    2
    CreateTime

    string

    クラスターの作成時刻です。形式は yyyy-MM-ddTHH:mm:ssZ です。

    2021-10-28T07:24:45Z
    PayType

    string

    課金方法です。有効値は次のとおりです。

    • Postpaid：従量課金

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

    Postpaid
    Tags

    object

    Tag

    array<object>

    タグリストです。

    object

    タグです。

    Key

    string

    タグのキーです。

    department
    Value

    string

    タグの値です。

    it
    StorageType

    string

    ストレージクラスです。有効値は次のとおりです。

    • CloudESSD：ESSD PL1

    • CloudESSD_PL2：ESSD PL2

    • CloudESSD_PL3：ESSD PL3

    • CloudEfficiency：Ultra ディスク

    CloudESSD
    Port

    integer

    HTTP ポートです。

    8123
    LockMode

    string

    クラスターのロックモードです。有効値は次のとおりです。

    • Unlock：クラスターはロックされていません。

    • ManualLock：クラスターは手動でロックされています。

    • LockByExpiration：クラスターは有効期限切れにより自動的にロックされています。

    • LockByRestoration：クラスターはロールバック前に自動的にロックされています。

    • LockByDiskQuota：クラスターはディスク容量超過により自動的にロックされています。

    Unlock
    Bid

    string

    サイト ID です。有効値は次のとおりです。

    • 26842：Alibaba Cloud China Website (www.aliyun.com)

    • 26888：Alibaba Cloud International Website (www.alibabacloud.com)

    26842
    IsExpired

    string

    クラスターが期限切れかどうかを示します。有効値は次のとおりです。

    • true：クラスターは期限切れです。

    • false：クラスターは期限切れではありません。

    false
    VpcCloudInstanceId

    string

    VPC インスタンスの ID です。

    vpc-bp175iuvg8nxqraf2****
    ScaleOutStatus

    object

    データ移行ステータスです。

    Progress

    string

    データ移行の進捗率 (%) です。

    説明

    このパラメーターは、クラスターが SCALING_OUT ステータスの場合にのみ返されます。

    0
    Ratio

    string

    データ移行の進捗状況です。形式は `移行済みデータ/合計データ` です。

    説明

    このパラメーターは、クラスターが SCALING_OUT ステータスの場合にのみ返されます。

    0MB/60469MB
    ScaleOutDisableWriteWindows

    string

    設定変更時の書き込みブロッキングウィンドウです。

    2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00
    DBClusterId

    string

    クラスター ID です。

    cc-bp108z124a8o7****
    ConnectionString

    string

    VPC エンドポイントです。

    cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com
    CommodityCode

    string

    商品コードです。

    clickhouse_go_public_cn
    ExpireTime

    string

    クラスターの有効期限です。形式は yyyy-MM-ddTHH:mm:ssZ です。

    説明

    従量課金クラスターには有効期限がなく、このパラメーターは空になります。

    2011-05-30T12:11:4Z
    DBNodeStorage

    integer

    シングルノードのストレージ容量です。値の範囲は 100 GB～32,000 GB です。

    説明

    ステップサイズは 100 GB です。

    100
    DBNodeClass

    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 メモリ

    • 単一レプリカエディションのクラスターの場合、有効値は次のとおりです。 - S4：4 コア、16 GB メモリ - S8：8 コア、32 GB メモリ

      • S16：16 コア、64 GB メモリ

      • S32：32 コア、128 GB メモリ

      • S64：64 コア、256 GB メモリ

      • S104：104 コア、384 GB メモリ

    • デュアルレプリカエディションのクラスターの場合、有効値は次のとおりです。 - C4：4 コア、16 GB メモリ - C8：8 コア、32 GB メモリ - C16：16 コア、64 GB メモリ - C32：32 コア、128 GB メモリ - C64：64 コア、256 GB メモリ - C104：104 コア、384 GB メモリ

    C8
    AliUid

    string

    Alibaba Cloud アカウント ID です。

    140692647406****
    LockReason

    string

    クラスターがロックされた理由です。

    説明

    クラスターがロックされていない場合は、このパラメーターは空になります。

    DISK_FULL
    RegionId

    string

    リージョン ID です。

    cn-hangzhou
    VSwitchId

    string

    vSwitch ID です。

    vsw-bp1gzt31twhlo0sa5****
    DBClusterStatus

    string

    クラスターのステータスです。有効値は次のとおりです。

    • Preparing：クラスターを準備中です。

    • Creating：クラスターを作成中です。

    • Running：クラスターが実行中です。

    • Deleting：クラスターを削除中です。

    • SCALING_OUT：クラスターをスケールアウト中です。

    Running
    DBClusterDescription

    string

    クラスターの説明です。

    test
    DBClusterNetworkType

    string

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

    VPC
    ZoneId

    string

    ゾーン ID です。

    cn-hangzhou-h
    Category

    string

    クラスターのエディションです。有効値は次のとおりです。

    • Basic：単一レプリカエディション

    • HighAvailability：デュアルレプリカエディション

    Basic
    ControlVersion

    string

    バックエンド管理システムのバージョンです。有効値は次のとおりです。

    • v1

    • v2

    v1
    ExtStorageType

    string

    拡張ストレージクラスです。有効値は次のとおりです。

    • CloudSSD：標準 SSD

    • CloudESSD：ESSD PL1

    • CloudESSD_PL2：ESSD PL2

    • CloudESSD_PL3：ESSD PL3

    • CloudEfficiency：Ultra ディスク

    CloudESSD
    ExtStorageSize

    integer

    拡張ストレージ容量です。

    100GB
    ResourceGroupId

    string

    クラスターが属するリソースグループの ID です。

    rg-4690g37929****
    DbVersion

    string

    クラスターのカーネルバージョンです。

    23.8

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber": 1,
  "DBClusters": {
    "DBCluster": [
      {
        "VpcId": "vpc-bp175iuvg8nxqraf2****",
        "DBNodeCount": 2,
        "CreateTime": "2021-10-28T07:24:45Z",
        "PayType": "Postpaid",
        "Tags": {
          "Tag": [
            {
              "Key": "department",
              "Value": "it"
            }
          ]
        },
        "StorageType": "CloudESSD",
        "Port": 8123,
        "LockMode": "Unlock",
        "Bid": "26842",
        "IsExpired": "false",
        "VpcCloudInstanceId": "vpc-bp175iuvg8nxqraf2****",
        "ScaleOutStatus": {
          "Progress": "0",
          "Ratio": "0MB/60469MB"
        },
        "ScaleOutDisableWriteWindows": "2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00",
        "DBClusterId": "cc-bp108z124a8o7****",
        "ConnectionString": "cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com",
        "CommodityCode": "clickhouse_go_public_cn",
        "ExpireTime": "2011-05-30T12:11:4Z",
        "DBNodeStorage": 100,
        "DBNodeClass": "C8",
        "AliUid": "140692647406****",
        "LockReason": "DISK_FULL",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-bp1gzt31twhlo0sa5****",
        "DBClusterStatus": "Running",
        "DBClusterDescription": "test",
        "DBClusterNetworkType": "VPC",
        "ZoneId": "cn-hangzhou-h",
        "Category": "Basic",
        "ControlVersion": "v1",
        "ExtStorageType": "CloudESSD",
        "ExtStorageSize": 0,
        "ResourceGroupId": "rg-4690g37929****",
        "DbVersion": "23.8"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    500 InternalError An error occurred while processing your request. An error occurred while processing your request.
    403 Forbidden User not authorized to operate on the specified resource.
    503 ServiceUnavailable An error occurred while processing your request. An error occurred while processing your request.

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

    変更履歴

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