AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云数据库 ClickHouse 开发参考 API参考（社区兼容版） API目录 集群管理 DescribeDBClusterAttribute - 查看集群的详细属性

DescribeDBClusterAttribute - 查看集群的详细属性

更新时间：
产品详情
我的收藏

查询指定云数据库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_PL0：ESSD PL0 云盘。

  • 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
VpcCloudInstanceId

string

VPC 资源 ID。

vpc-bp10tr8k9qasioaty****
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
VpcIpAddr

string

VPC 网络连接串的 IP 地址。

192.168.xx.xx
EngineMinorVersion

string

当前的小版本号。

1.6.0
EngineLatestMinorVersion

string

可升级的最新小版本号。

1.34.0
MaintainAutoType

boolean

升级类型。false 为手动升级。

false
ExtStorageType

string

扩展存储类型，取值说明：

  • CloudESSD_PL0：ESSD PL0 云盘。

  • 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
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"
    },
    "VpcCloudInstanceId": "vpc-bp10tr8k9qasioaty****",
    "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",
    "VpcIpAddr": "192.168.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
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}

错误码

HTTP status code

错误码

错误信息

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

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：DescribeDBClusters - 查询集群列表下一篇：DescribeDBClusterConfig - 查看集群参数配置信息