DescribeCluster - 查看集群信息_云数据库 ClickHouse-阿里云帮助中心

调用DescribeCluster接口查看云数据库ClickHouse云原生版集群的信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群ID。	cc-uf6a499c0m3w5****
RegionId	string	否	地域ID。您可以通过调用DescribeRegions接口查询地域ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	PlainResponse
Data	object	返回的结果。
DBClusterId	string	集群ID。	cc-uf6a499c0m3w5****
DBClusterDescription	string	集群描述。	test
EngineVersion	string	集群的内核版本号，固定为21.8。	21.8
AliUid	long	阿里云账号ID。	140692647406****
RegionId	string	地域ID。	cn-hangzhou
VpcId	string	VPC ID。	vpc-wz9duj8xd6r1gzhsg*****
ZoneId	string	可用区ID。	cn-hangzhou-h
VswitchId	string	交换机ID。	vsw-2vcmrf8c878scsv43****
PayType	string	付费类型，取值说明： Postpaid：按量付费。 Prepaid：预付费（包年包月）。	Postpaid
CommodityCode	string	售卖商品Code。	clickhouse_go_public_cn
CreateTime	string	集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。	2022-03-18T08:14:48Z
ExpireTime	string	集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。说明按量付费集群无到期时间，返回值为空。	2022-04-17T08:14:48Z
LockMode	string	集群的锁定模式，取值说明： Unlock：正常。 ManualLock：手动触发锁定。 LockByExpiration：集群过期自动锁定。 LockByRestoration：集群回滚前的自动锁定。 LockByDiskQuota：集群空间满自动锁定。	Unlock
LockReason	string	锁定原因。说明锁定模式为Unlock时，返回值为空。	DISK_FULL
DBClusterStatus	string	集群的状态，取值说明： OrderPreparing：订单确认中。 Creating：创建中。 Running：运行中。 ResourceChanging：资源变配中。 ResourceChangingInReadonly：资源变配中（实例写入锁定）。 Deleting：删除中。	Running
ResourceCpuCores	integer	集群的CPU规格，单位：核。	8
ResourceMemoryGiB	integer	集群的内存规格，单位：GB。	32
CacheStorageType	string	集群的缓存类型。	CloudESSD
CacheStorageSizeGiB	integer	集群的缓存空间，单位：GB。	200
ObjectStoreSizeGiB	long	集群的存储用量，单位：GB。	0
VirtualWareHouses	object []	计算组列表。
VirtualWareHouseId	string	计算组ID。	vw-bp1w2728d535t****
VirtualWareHouseDescription	string	计算组描述。	test
VirtualWareHouseStatus	string	计算组状态，取值说明： Creating：创建中。 Running：运行中。 CreatingPublicSLB：创建公网链接中。 DeletingPublicSLB：释放公网链接中。 ResourceChanging：资源变配中。 ResourceChangingInReadonly：资源变配中（计算组写入锁定）。 Deleting：删除中。	Running
ZoneId	string	可用区ID。	cn-hangzhou-h
VswitchId	string	交换机ID。	vsw-2vcmrf8c878scsv43****
VirtualWareHouseClass	string	计算组的规格码。	n1.xlarge
VirtualWareHouseCacheStorage	integer	计算组的缓存空间，单位：GB。	200
Ports	string	计算组的端口号。	tcp:9000,http:8123,mysql:9004
RequestId	string	请求ID。	9140518B-F330-5364-82FE-EC7298816EDF

示例

正常返回示例

JSON格式

{
  "Data": {
    "DBClusterId": "cc-uf6a499c0m3w5****",
    "DBClusterDescription": "test",
    "EngineVersion": "21.8",
    "AliUid": 0,
    "RegionId": "cn-hangzhou",
    "VpcId": "vpc-wz9duj8xd6r1gzhsg*****",
    "ZoneId": "cn-hangzhou-h",
    "VswitchId": "vsw-2vcmrf8c878scsv43****",
    "PayType": "Postpaid",
    "CommodityCode": "clickhouse_go_public_cn",
    "CreateTime": "2022-03-18T08:14:48Z",
    "ExpireTime": "2022-04-17T08:14:48Z",
    "LockMode": "Unlock",
    "LockReason": "DISK_FULL",
    "DBClusterStatus": "Running",
    "ResourceCpuCores": 8,
    "ResourceMemoryGiB": 32,
    "CacheStorageType": "CloudESSD",
    "CacheStorageSizeGiB": 200,
    "ObjectStoreSizeGiB": 0,
    "VirtualWareHouses": [
      {
        "VirtualWareHouseId": "vw-bp1w2728d535t****",
        "VirtualWareHouseDescription": "test",
        "VirtualWareHouseStatus": "Running",
        "ZoneId": "cn-hangzhou-h",
        "VswitchId": "vsw-2vcmrf8c878scsv43****",
        "VirtualWareHouseClass": "n1.xlarge",
        "VirtualWareHouseCacheStorage": 200,
        "Ports": "tcp:9000,http:8123,mysql:9004"
      }
    ]
  },
  "RequestId": "9140518B-F330-5364-82FE-EC7298816EDF"
}

错误码

HTTP status code	错误码	错误信息
500	InternalError	The request processing has failed due to some unknown error, exception or failure.

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