调用DescribeDBClusterAttribute接口查询云数据库ClickHouse社区兼容版集群的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBClusterAttribute |
系统规定参数。取值:DescribeDBClusterAttribute。 |
DBClusterId | String | 是 | cc-bp108z124a8o7**** |
集群ID。您可以通过调用DescribeDBClusters接口查询目标地域下所有的集群信息,包括集群ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBCluster | Object |
集群。 |
|
VpcId | String | vpc-bp10tr8k9qasioaty**** |
VPC ID。 |
SupportBackup | Integer | 1 |
是否支持数据备份,取值说明:
|
SupportOss | Integer | 1 |
是否支持冷热数据分层存储,取值说明:
|
EncryptionType | String | CloudDisk |
加密类型,取值说明:
|
DBNodeCount | Long | 1 |
节点数量。
|
MaintainTime | String | 00:00Z-01:00Z |
集群的可维护时间段。格式:HH:mmZ-HH:mmZ(UTC时间)。 示例:00:00Z-01:00Z,表示UTC时间的0点到1点(即北京时间的8点到9点)可进行例行维护。 |
CreateTime | String | 2021-12-13T11:33:11Z |
集群的创建时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
PayType | String | Prepaid |
付费类型,取值说明:
|
Tags | Array of Tag |
标签列表。 |
|
Tag | |||
Key | String | department |
标签的名称。 |
Value | String | it |
标签的值。 |
PublicConnectionString | String | cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com |
外网连接地址。 |
StorageType | String | CloudESSD |
存储类型,取值说明:
|
Port | Integer | 8123 |
HTTP端口号。 |
LockMode | String | Unlock |
集群的锁定模式,取值说明:
|
Bid | String | 26842 |
站点ID,取值说明:
|
EngineVersion | String | 21.8.10.19 |
引擎版本。 |
IsExpired | String | false |
集群是否过期,取值说明:
|
ScaleOutStatus | Object |
数据搬迁状态。 |
|
Progress | String | 0 |
数据搬迁百分比。 说明 仅集群状态为SCALING_OUT时,返回该参数。
|
Ratio | String | 0MB/60469MB |
数据搬迁的进度,格式:已搬迁数据量/数据总量。 说明 仅集群状态为SCALING_OUT时,返回该参数。
|
VpcCloudInstanceId | String | vpc-bp10tr8k9qasioaty**** |
VPC资源ID。 |
DBClusterId | String | cc-bp108z124a8o7**** |
集群ID。 |
ConnectionString | String | cc-bp1qx68m06981****.ads.rds.aliyuncs.com |
VPC连接地址。 |
EncryptionKey | String | 685f416f-87c9-4554-8d3a-75b6ce25**** |
KMS密钥。 说明 加密类型为off时,返回值为空。
|
DBClusterType | String | Common |
集群类型,取值说明:
|
CommodityCode | String | clickhouse_go_public_cn |
售卖商品Code。 |
ExpireTime | String | 2022-11-11T16:00:00Z |
集群的到期时间,格式:yyyy-MM-ddTHH:mm:ssZ。 说明 按量付费集群无到期时间,返回值为空。
|
DBNodeStorage | Long | 100 |
单节点存储空间,单位:GB。 取值范围:100~32000。 说明 步长为100 GB。
|
DBNodeClass | String | C8 |
集群规格。
|
AliUid | String | 140692647406**** |
阿里云账号ID。 |
LockReason | String | DISK_FULL |
锁定原因。 说明 锁定模式为Unlock时,返回值为空。
|
RegionId | String | cn-hangzhou |
地域ID。 |
PublicPort | String | 3306 |
公网TCP端口号。 |
VSwitchId | String | vsw-bp1n874li1t5y57wi**** |
交换机ID。 |
DBClusterStatus | String | Running |
集群状态,取值说明:
|
DBClusterNetworkType | String | vpc |
网络类型,目前只支持VPC。 |
DBClusterDescription | String | cc-bp108z124a8o7**** |
集群描述。 |
ZoneId | String | cn-hangzhou-h |
可用区ID。 |
Category | String | HighAvailability |
副本配置,取值说明:
|
Engine | String | ClickHouse |
引擎类型。 |
SupportMysqlPort | Boolean | false |
是否支持MySQL端口,取值说明:
|
SupportHttpsPort | Boolean | false |
是否支持HTTP端口,取值说明:
|
ControlVersion | String | v1 |
后台管控系统版本号,取值说明:
|
PublicIpAddr | String | 121.40.xx.xx |
外网连接串的IP地址。 |
VpcIpAddr | String | 192.168.xx.xx |
VPC网络连接串的IP地址。 |
EngineMinorVersion | String | 1.6.0 |
当前的小版本号。 |
EngineLatestMinorVersion | String | 1.34.0 |
可升级的最新小版本号。 |
MaintainAutoType | Boolean | false |
升级类型。false为手动升级。 |
RequestId | String | 05321590-BB65-4720-8CB6-8218E041CDD0 |
请求ID。 |
示例
请求示例
http(s)://clickhouse.aliyuncs.com/?Action=DescribeDBClusterAttribute
&DBClusterId=cc-bp108z124a8o7****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBClusterAttributeResponse>
<DBCluster>
<VpcId>vpc-bp10tr8k9qasioaty****</VpcId>
<SupportBackup>1</SupportBackup>
<SupportOss>1</SupportOss>
<EncryptionType>CloudDisk</EncryptionType>
<DBNodeCount>1</DBNodeCount>
<MaintainTime>00:00Z-01:00Z</MaintainTime>
<CreateTime>2021-12-13T11:33:11Z</CreateTime>
<PayType>Prepaid</PayType>
<Tags>
<Key>department</Key>
<Value>it</Value>
</Tags>
<PublicConnectionString>cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com</PublicConnectionString>
<StorageType>CloudESSD</StorageType>
<Port>8123</Port>
<LockMode>Unlock</LockMode>
<Bid>26842</Bid>
<EngineVersion>21.8.10.19</EngineVersion>
<IsExpired>false</IsExpired>
<ScaleOutStatus>
<Progress>0</Progress>
<Ratio>0MB/60469MB</Ratio>
</ScaleOutStatus>
<VpcCloudInstanceId>vpc-bp10tr8k9qasioaty****</VpcCloudInstanceId>
<DBClusterId>cc-bp108z124a8o7****</DBClusterId>
<ConnectionString>cc-bp1qx68m06981****.ads.rds.aliyuncs.com</ConnectionString>
<EncryptionKey>685f416f-87c9-4554-8d3a-75b6ce25****</EncryptionKey>
<DBClusterType>Common</DBClusterType>
<CommodityCode>clickhouse_go_public_cn</CommodityCode>
<ExpireTime>2022-11-11T16:00:00Z</ExpireTime>
<DBNodeStorage>100</DBNodeStorage>
<DBNodeClass>C8</DBNodeClass>
<AliUid>140692647406****</AliUid>
<LockReason>DISK_FULL</LockReason>
<RegionId>cn-hangzhou</RegionId>
<PublicPort>3306</PublicPort>
<VSwitchId>vsw-bp1n874li1t5y57wi****</VSwitchId>
<DBClusterStatus>Running</DBClusterStatus>
<DBClusterNetworkType>vpc</DBClusterNetworkType>
<DBClusterDescription>cc-bp108z124a8o7****</DBClusterDescription>
<ZoneId>cn-hangzhou-h</ZoneId>
<Category>HighAvailability</Category>
<Engine>ClickHouse</Engine>
<SupportMysqlPort>false</SupportMysqlPort>
<SupportHttpsPort>false</SupportHttpsPort>
<ControlVersion>v1</ControlVersion>
<PublicIpAddr>121.40.xx.xx</PublicIpAddr>
<VpcIpAddr>192.168.xx.xx</VpcIpAddr>
<EngineMinorVersion>1.6.0</EngineMinorVersion>
<EngineLatestMinorVersion>1.34.0</EngineLatestMinorVersion>
<MaintainAutoType>false</MaintainAutoType>
</DBCluster>
<RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>
</DescribeDBClusterAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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" : [ {
"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
},
"RequestId" : "05321590-BB65-4720-8CB6-8218E041CDD0"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。 |
访问错误中心查看更多错误码。