DescribeDBInstanceAttribute - 查询集群的详细信息_云数据库 ClickHouse(ClickHouse)-阿里云帮助中心

调用DescribeDBInstanceAttribute接口查询云数据库ClickHouse企业版集群的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
clickhouse:DescribeDBInstanceAttribute	get	*EnterpriseDBCluster `acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	集群 ID。	cc-bp100p4q1g9z3****
RegionId	string	否	地域 ID。枚举值： cn-beijing：cn-beijing。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	2FED790E-FB61-4721-8C1C-07C627FA5A19
Data	object	返回结果。
DBInstanceId	string	集群 ID。	cc-bp100p4q1g9z3****
Description	string	集群描述。	集群测试
Engine	string	引擎类型。	clickhouse
EngineVersion	string	引擎版本。	23.8
AliUid	long	阿里云账号 ID。	140692647406****
Bid	string	渠道 ID。	PD39050615820269****
RegionId	string	地域 ID。	cn-hangzhou
DeploySchema	string	集群可用区部署状态，支持 single_az 和 multi_az 两种类型。 single_az：server 部署到主可用区 ZoneId。 multi_az：server 部署到多可用区 MultiZones。 keeper 始终部署到多可用区 MultiZones。	single_az
MultiZones	array<object>	多可用信息。
MultiZone	object
VSwitchIds	array	交换机 ID 数组。
VSwitchId	string	交换机 ID。	vsw-bj9kpwhcb9iekphje1ljz
ZoneId	string	可用区 ID。	cn-hangzhou-h
ChargeType	string	付费方式。企业版集群的付费方式都是按量付费方式。	POSTPAY
Status	string	实例状态。	ACTIVATION
VpcId	string	VPC ID。	vpc-wz9duj8xd6r1gzhsg*****
VSwitchId	string	交换机 ID。	vsw-uf67ij56zm9x4uc6hmilg
ScaleMin	integer	serverless 弹性伸缩最小值。	8
ScaleMax	integer	serverless 弹性伸缩最大值。	32
StorageSize	integer	存储空间大小。单位：GB	12
StorageType	string	存储类型。	100
ObjectStoreSize	string	对象存储大小。	13
ExpireTime	string	集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。说明按量付费集群无到期时间，返回值为空。	2024-04-17T08:14:48Z
LockMode	string	集群的锁定模式。	0
LockReason	string	锁定原因。	nolock
MaintainStartTime	string	可维护时间开始时间。	11:00Z
MaintainEndTime	string	可维护时间结束时间。	12:00Z
DeletionProtection	boolean	是否已开启释放保护功能。	0/1
ResourceGroupId	string	资源 ID。	rg-acfmzygvt54****
Tags	array<object>	标签信息。
Tag	object	标签信息。
Key	string	标签的名称。	id
Value	string	标签的值。	ck
Nodes	array<object>	节点信息。
Node	object	节点信息。
ZoneId	string	可用区 ID。	cn-hangzhou-h
NodeStatus	string	节点运行状态。	active
CreateTime	string	集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。	2023-09-14T08:14:48Z
EngineMinorVersion	string	集群引擎的小版本号。	23.8.1.41495_6
LatestEngineMinorVersion	string	最新内核小版本号。	23.8.1.41495_6
DisabledPorts	string	禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。	9001,8123
ZoneId	string	可用区 ID。	cn-hangzhou-h

示例

正常返回示例

JSON格式

{
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627FA5A19",
  "Data": {
    "DBInstanceId": "cc-bp100p4q1g9z3****",
    "Description": "集群测试",
    "Engine": "clickhouse",
    "EngineVersion": 23.8,
    "AliUid": 0,
    "Bid": "PD39050615820269****",
    "RegionId": "cn-hangzhou",
    "DeploySchema": "single_az",
    "MultiZones": [
      {
        "VSwitchIds": [
          "vsw-bj9kpwhcb9iekphje1ljz"
        ],
        "ZoneId": "cn-hangzhou-h"
      }
    ],
    "ChargeType": "POSTPAY",
    "Status": "ACTIVATION",
    "VpcId": "vpc-wz9duj8xd6r1gzhsg*****",
    "VSwitchId": "vsw-uf67ij56zm9x4uc6hmilg",
    "ScaleMin": 8,
    "ScaleMax": 32,
    "StorageSize": 12,
    "StorageType": 100,
    "ObjectStoreSize": 13,
    "ExpireTime": "2024-04-17T08:14:48Z",
    "LockMode": 0,
    "LockReason": "nolock",
    "MaintainStartTime": "11:00Z",
    "MaintainEndTime": "12:00Z",
    "DeletionProtection": true,
    "ResourceGroupId": "rg-acfmzygvt54****",
    "Tags": [
      {
        "Key": "id",
        "Value": "ck"
      }
    ],
    "Nodes": [
      {
        "ZoneId": "cn-hangzhou-h",
        "NodeStatus": "active"
      }
    ],
    "CreateTime": "2023-09-14T08:14:48Z",
    "EngineMinorVersion": "23.8.1.41495_6",
    "LatestEngineMinorVersion": "23.8.1.41495_6",
    "DisabledPorts": "9001,8123",
    "ZoneId": "cn-hangzhou-h"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-05-13	API 内部配置变更，不影响调用	查看变更详情
2023-11-21	OpenAPI 返回结构发生变更	查看变更详情
2023-10-12	OpenAPI 返回结构发生变更	查看变更详情