すべてのプロダクト
Search

このプロダクト

    ApsaraDB for ClickHouse:DescribeDBClusterAttribute

    ドキュメントセンター

    ApsaraDB for ClickHouse:DescribeDBClusterAttribute

    最終更新日:Aug 11, 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:DescribeDBClusterAttribute

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスターの ID。 DescribeDBClusters 操作を呼び出して、対象リージョン内のすべてのクラスターに関する情報（クラスター ID を含む）を取得できます。

    cc-bp108z124a8o7****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返される結果。

    DBCluster

    object

    クラスター情報。

    VpcId

    string

    VPC の ID。

    vpc-bp10tr8k9qasioaty****
    SupportBackup

    integer

    データバックアップがサポートされているかどうかを示します。有効な値:

    1
    SupportOss

    integer

    ホットデータとコールドデータのハイブリッドストレージがサポートされているかどうかを示します。有効な値:

    1
    EncryptionType

    string

    暗号化タイプ。有効な値:

    CloudDisk
    DBNodeCount

    integer

    ノード数。

    1
    MaintainTime

    string

    クラスターのメンテナンスウィンドウ。時間は HH:mmZ-HH:mmZ フォーマット (UTC) です。

    00:00Z-01:00Z
    CreateTime

    string

    クラスターが作成された時刻。時間は yyyy-MM-ddTHH:mm:ssZ フォーマット (UTC) です。

    2021-12-13T11:33:11Z
    PayType

    string

    課金方法。有効な値:

    Prepaid
    Tags

    object

    Tag

    array<object>

    タグのリスト。

    object

    タグ。

    Key

    string

    タグキー。

    department
    Value

    string

    タグ値。

    it
    PublicConnectionString

    string

    パブリックエンドポイント。

    cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com
    StorageType

    string

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

    CloudESSD
    Port

    integer

    HTTP ポート番号。

    8123
    LockMode

    string

    クラスターのロックモード。有効な値:

    Unlock
    Bid

    string

    サイト ID。有効な値:

    26842
    EngineVersion

    string

    DPI エンジンのバージョン。

    21.8.10.19
    IsExpired

    string

    クラスターが期限切れかどうかを示します。有効な値:

    false
    ScaleOutStatus

    object

    データ移行のステータス。

    Progress

    string

    データ移行の進捗状況（パーセンテージ）。

    0
    Ratio

    string

    データ移行の進捗状況（移行済みデータ量/総データ量のフォーマット）。

    0MB/60469MB
    LbKind

    string

    負荷分散タイプ。

    clb
    DBClusterId

    string

    クラスターの ID。

    cc-bp108z124a8o7****
    ConnectionString

    string

    VPC エンドポイント。

    cc-bp1qx68m06981****.ads.rds.aliyuncs.com
    EncryptionKey

    string

    Key Management サービス (KMS) キー。

    685f416f-87c9-4554-8d3a-75b6ce25****
    DBClusterType

    string

    クラスタータイプ。有効な値:

    Common
    CommodityCode

    string

    商品コード。

    clickhouse_go_public_cn
    ExpireTime

    string

    クラスターの有効期限。時間は yyyy-MM-ddTHH:mm:ssZ フォーマットです。

    2022-11-11T16:00:00Z
    DBNodeStorage

    integer

    ノードあたりのストレージ容量。単位: GB。

    100
    DBNodeClass

    string

    クラスターのスペック。有効な値:

    C8
    AliUid

    string

    Alibaba Cloud アカウントの ID。

    140692647406****
    LockReason

    string

    クラスターがロック済みの理由。

    DISK_FULL
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    PublicPort

    string

    パブリック TCP ポート番号。

    3306
    VSwitchId

    string

    vSwitch の ID。

    vsw-bp1n874li1t5y57wi****
    DBClusterStatus

    string

    クラスターのステータス。有効な値:

    Running
    DBClusterNetworkType

    string

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

    vpc
    DBClusterDescription

    string

    クラスターの説明。

    cc-bp108z124a8o7****
    ZoneId

    string

    ゾーンの ID。

    cn-hangzhou-h
    Category

    string

    レプリカの構成。有効な値:

    HighAvailability
    Engine

    string

    エンジンタイプ。

    ClickHouse
    SupportMysqlPort

    boolean

    MySQL ポートがサポートされているかどうかを示します。有効な値:

    false
    SupportHttpsPort

    boolean

    HTTPS ポートがサポートされているかどうかを示します。有効な値:

    false
    ControlVersion

    string

    バックエンド管理システムのバージョン。有効な値:

    v1
    PublicIpAddr

    string

    パブリックエンドポイントの IP アドレス。

    121.40.xx.xx
    EngineMinorVersion

    string

    現在のマイナーバージョン。

    1.6.0
    EngineLatestMinorVersion

    string

    スペックアップ可能な最新のマイナーバージョン。

    1.34.0
    MaintainAutoType

    boolean

    スペックアップタイプ。false は手動スペックアップを示します。

    false
    ExtStorageType

    string

    拡張ストレージタイプ。有効な値:

    CloudESSD
    ExtStorageSize

    integer

    拡張ストレージ容量。単位: GB。

    500
    ResourceGroupId

    string

    リソースグループの ID。

    rg-acfmyf65je6****
    ZookeeperClass

    string

    ZooKeeper のスペック。

    4 Core 8 GB
    AppointmentRestartTime

    string

    スケジュールされた再起動時刻。時間は YYYY-MM-DDThh:mm:ssZ フォーマット (UTC) です。

    2023-11-06T12:00:00Z
    ZoneIdVswitchMap

    object

    マルチゾーンインスタンスの vSwitch ID のリスト。

    cn-shanghai-f: vsw-zm0n42d5vvuo****
    AvailableUpgradeMajorVersion

    object

    スペックアップ可能なターゲットメジャーバージョン。

    {"MajorVersion":"MinorVersion"}
    AppointmentRestartNodeTime

    string

    特定のノードを再起動するスケジュール時刻。時間は YYYY-MM-DDThh:mm:ssZ フォーマット (UTC) です。

    2023-11-06T12:00:00Z
    AppointmentRestartNodeList

    string

    再起動がスケジュールされているノードのリスト。

    ck-k1a976p3n********-****-clickhouse-s-0-r-0,ck-k1a976p3n********-****-clickhouse-s-0-r-1
    AppointmentElectZookeeperTime

    string

    リーダー選出のスケジュール時刻。時間は YYYY-MM-DDThh:mm:ssZ フォーマット (UTC) です。

    2023-11-06T12:00:00Z
    AppointmentElectZookeeperDisableWrite

    boolean

    リーダー選出中の書き込み停止構成。有効な値:

    true
    VpcIpAddr

    string

    VPC ネットワーク接続性文字列の IP アドレス。

    192.168.xx.xx
    VpcCloudInstanceId

    string

    VPC リソースの ID。

    vpc-bp10tr8k9qasioaty****
    WebUIStatus

    string

    WebUI のステータス。

    active
    WebUISnatStatus

    string

    WebUI パブリックネットワークゲートウェイのステータス。

    active
    LangfuseInstanceIds

    object

    LangfuseInstanceId

    array

    string

    RequestId

    string

    リクエスト ID。

    05321590-BB65-4720-8CB6-8218E041CDD0

    例

    成功レスポンス

    JSONJSON

    {
  "DBCluster": {
    "VpcId": "vpc-bp10tr8k9qasioaty****",
    "SupportBackup": 1,
    "SupportOss": 1,
    "EncryptionType": "CloudDisk",
    "DBNodeCount": 1,
    "MaintainTime": "00:00Z-01:00Z",
    "CreateTime": "2021-12-13T11:33:11Z",
    "PayType": "Prepaid",
    "Tags": {
      "Tag": [
        {
          "Key": "department",
          "Value": "it"
        }
      ]
    },
    "PublicConnectionString": "cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com",
    "StorageType": "CloudESSD",
    "Port": 8123,
    "LockMode": "Unlock",
    "Bid": "26842",
    "EngineVersion": "21.8.10.19",
    "IsExpired": "false",
    "ScaleOutStatus": {
      "Progress": "0",
      "Ratio": "0MB/60469MB"
    },
    "LbKind": "clb",
    "DBClusterId": "cc-bp108z124a8o7****",
    "ConnectionString": "cc-bp1qx68m06981****.ads.rds.aliyuncs.com",
    "EncryptionKey": "685f416f-87c9-4554-8d3a-75b6ce25****",
    "DBClusterType": "Common",
    "CommodityCode": "clickhouse_go_public_cn",
    "ExpireTime": "2022-11-11T16:00:00Z",
    "DBNodeStorage": 100,
    "DBNodeClass": "C8",
    "AliUid": "140692647406****",
    "LockReason": "DISK_FULL",
    "RegionId": "cn-hangzhou",
    "PublicPort": "3306",
    "VSwitchId": "vsw-bp1n874li1t5y57wi****",
    "DBClusterStatus": "Running",
    "DBClusterNetworkType": "vpc",
    "DBClusterDescription": "cc-bp108z124a8o7****",
    "ZoneId": "cn-hangzhou-h",
    "Category": "HighAvailability",
    "Engine": "ClickHouse",
    "SupportMysqlPort": false,
    "SupportHttpsPort": false,
    "ControlVersion": "v1",
    "PublicIpAddr": "121.40.xx.xx",
    "EngineMinorVersion": "1.6.0",
    "EngineLatestMinorVersion": "1.34.0",
    "MaintainAutoType": false,
    "ExtStorageType": "CloudESSD",
    "ExtStorageSize": 500,
    "ResourceGroupId": "rg-acfmyf65je6****",
    "ZookeeperClass": "4 Core 8 GB",
    "AppointmentRestartTime": "2023-11-06T12:00:00Z",
    "ZoneIdVswitchMap": {
      "test": "test",
      "test2": 1
    },
    "AvailableUpgradeMajorVersion": {
      "MajorVersion": "MinorVersion"
    },
    "AppointmentRestartNodeTime": "2023-11-06T12:00:00Z",
    "AppointmentRestartNodeList": "ck-k1a976p3n********-****-clickhouse-s-0-r-0,ck-k1a976p3n********-****-clickhouse-s-0-r-1",
    "AppointmentElectZookeeperTime": "2023-11-06T12:00:00Z",
    "AppointmentElectZookeeperDisableWrite": true,
    "VpcIpAddr": "192.168.xx.xx",
    "VpcCloudInstanceId": "vpc-bp10tr8k9qasioaty****",
    "WebUIStatus": "active",
    "WebUISnatStatus": "active",
    "LangfuseInstanceIds": {
      "LangfuseInstanceId": [
        ""
      ]
    }
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The DBClusterId provided does not exist in our records.

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

    変更履歴

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