幫助中心
首頁 ApsaraDB for ClickHouse 開發參考 API參考（社區相容版） API目錄 其他 DescribeDBClusterAttribute - 查看叢集的詳細屬性

DescribeDBClusterAttribute - 查看叢集的詳細屬性

更新時間：
Copy as MD
產品

查詢指定雲資料庫ClickHouse叢集的資訊。

調試

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

調試

授權資訊

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

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

  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:DescribeDBClusterAttribute

get

*全部資源

*

 無 無

請求參數

名稱

類型

必填

描述

樣本值
DBClusterId

string

是

叢集 ID。您可以通過調用 DescribeDBClusters 介面查詢目標地區下所有的叢集資訊，包括叢集 ID。

cc-bp108z124a8o7****

返回參數

名稱

類型

描述

樣本值

object

返回的結果。

DBCluster

object

叢集資訊。

VpcId

string

VPC ID。

vpc-bp10tr8k9qasioaty****
SupportBackup

integer

是否支援資料備份，取值說明：

  • 1：支援資料備份。

  • 2：不支援資料備份。

1
SupportOss

integer

是否支援冷熱資料階層式存放區，取值說明：

  • 1：支援冷熱資料階層式存放區。

  • 2：不支援冷熱資料階層式存放區。

1
EncryptionType

string

加密類型，取值說明：

  • CloudDisk：雲端硬碟加密。

  • off：不加密。

CloudDisk
DBNodeCount

integer

節點數量。

  • 單副本版，取值範圍：1~48。

  • 雙副本版，取值範圍：1~24。

1
MaintainTime

string

叢集的可維護時間段。格式：HH:mmZ-HH:mmZ（UTC 時間）。

樣本：00:00Z-01:00Z，表示 UTC 時間的 0 點到 1 點（即北京時間的 8 點到 9 點）可進行例行維護。

00:00Z-01:00Z
CreateTime

string

叢集的建立時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

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

string

付費類型，取值說明：

  • Postpaid：隨用隨付。

  • Prepaid：預付費（訂用帳戶）。

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：ESSD PL1 雲端硬碟。

  • CloudESSD_PL2：ESSD PL2 雲端硬碟。

  • CloudESSD_PL3：ESSD PL3 雲端硬碟。

  • CloudEfficiency：高效雲端硬碟。

CloudESSD
Port

integer

HTTP 連接埠號碼。

8123
LockMode

string

叢集的鎖定模式，取值說明：

  • Unlock：正常。

  • ManualLock：手動觸發鎖定。

  • LockByExpiration：叢集到期自動鎖定。

  • LockByRestoration：叢集復原前的自動鎖定。

  • LockByDiskQuota：叢集空間滿自動鎖定。

Unlock
Bid

string

網站 ID，取值說明：

  • 26842：中國站。

  • 26888：國際站。

26842
EngineVersion

string

引擎版本。

21.8.10.19
IsExpired

string

叢集是否到期，取值說明：

  • true：已到期。

  • false：未到期。

false
ScaleOutStatus

object

資料搬遷狀態。

Progress

string

資料搬遷百分比。

說明

僅叢集狀態為 SCALING_OUT 時，返回該參數。

0
Ratio

string

資料搬遷的進度，格式：已搬遷資料量/資料總量。

說明

僅叢集狀態為 SCALING_OUT 時，返回該參數。

0MB/60469MB
LbKind

string

LoadBalance 類型。

clb
DBClusterId

string

叢集 ID。

cc-bp108z124a8o7****
ConnectionString

string

VPC 串連地址。

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

string

KMS 密鑰。

說明

加密類型為 off 時，傳回值為空白。

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

string

叢集類型，取值說明：

  • Common：正常叢集。

  • Readonly：唯讀叢集。

  • Guard：災備叢集。

Common
CommodityCode

string

售賣商品 Code。

clickhouse_go_public_cn
ExpireTime

string

叢集的到期時間，格式：yyyy-MM-ddTHH:mm:ssZ。

說明

隨用隨付叢集無到期時間，傳回值為空白。

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

integer

單節點儲存空間，單位：GB。

取值範圍：100~32000。

說明

步長為 100 GB。

100
DBNodeClass

string

叢集規格。

  • 單副本版，取值：

    • S4-NEW

    • S8

    • S16

    • S32

    • S64

    • S104

  • 雙副本版，取值：

    • C4-NEW

    • C8

    • C16

    • C32

    • C64

    • C104

C8
AliUid

string

阿里雲帳號 ID。

140692647406****
LockReason

string

鎖定原因。

說明

鎖定模式為 Unlock 時，傳回值為空白。

DISK_FULL
RegionId

string

地區 ID。

cn-hangzhou
PublicPort

string

公網 TCP 通訊埠號。

3306
VSwitchId

string

交換器 ID。

vsw-bp1n874li1t5y57wi****
DBClusterStatus

string

叢集狀態，取值說明：

  • Preparing：準備中。

  • Creating：建立中。

  • Running：運行中。

  • Deleting：刪除中。

  • SCALING_OUT：擴容中。

Running
DBClusterNetworkType

string

網路類型，目前只支援 VPC。

vpc
DBClusterDescription

string

叢集描述。

cc-bp108z124a8o7****
ZoneId

string

可用性區域 ID。

cn-hangzhou-h
Category

string

副本配置，取值說明：

  • Basic：單副本版。

  • HighAvailability：雙副本版。

HighAvailability
Engine

string

引擎類型。

ClickHouse
SupportMysqlPort

boolean

是否支援 MySQL 連接埠，取值說明：

  • true：支援 MySQL 連接埠。

  • false：不支援 MySQL 連接埠。

false
SupportHttpsPort

boolean

是否支援 HTTPS 連接埠，取值說明：

  • true：支援 HTTPS 連接埠。

  • false：不支援 HTTPS 連接埠。

false
ControlVersion

string

後台管控系統版本號碼，取值說明：

  • v1

  • v2

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：ESSD PL1 雲端硬碟。

  • CloudESSD_PL2：ESSD PL2 雲端硬碟。

  • CloudESSD_PL3：ESSD PL3 雲端硬碟。

  • CloudEfficiency：高效雲端硬碟。

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

多可用性區域執行個體交換器 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: 切主時對執行個體配置停寫。

  • false: 切主時不對執行個體配置停寫。

true
VpcIpAddr

string

VPC 網路連接串的 IP 位址。

192.168.xx.xx
VpcCloudInstanceId

string

VPC 資源 ID。

vpc-bp10tr8k9qasioaty****
WebUIStatus

string

active
WebUISnatStatus

string

active
RequestId

string

請求 ID。

05321590-BB65-4720-8CB6-8218E041CDD0

樣本

正常返回樣本

JSON格式

{
  "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"
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，請確認 DBClusterId 值是否正確。

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

變更歷史

更多資訊，參考變更詳情。

上一篇：DescribeDBClusterAccessWhiteList - 查看叢集的IP白名單下一篇：DescribeDBClusterConfig - 查看叢集參數配置資訊