DescribeDBClusterAttribute - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries information about an ApsaraDB for ClickHouse cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

clickhouse:DescribeDBClusterAttribute

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. You can call the DescribeDBClusters operation to query information about all clusters in the destination region. The information includes cluster IDs.	cc-bp108z124a8o7****

Response elements

Element	Type	Description	Example
	object	The response parameters.
DBCluster	object	The cluster information.
VpcId	string	The VPC ID.	vpc-bp10tr8k9qasioaty****
SupportBackup	integer	Indicates whether data backup is supported. Valid values: 1: Supported. 2: Not supported.	1
SupportOss	integer	Indicates whether tiered storage of hot and cold data is supported. Valid values: 1: Supported. 2: Not supported.	1
EncryptionType	string	The encryption type. Valid values: CloudDisk: Disk encryption. off: Encryption is disabled.	CloudDisk
DBNodeCount	integer	The number of nodes. For a single-replica edition, the value ranges from 1 to 48. For a dual-replica edition, the value ranges from 1 to 24.	1
MaintainTime	string	The maintenance window of the cluster. The time is in UTC and the format is HH:mmZ-HH:mmZ. For example, 00:00Z-01:00Z indicates that routine maintenance can be performed from 00:00 to 01:00 (UTC). This corresponds to 08:00 to 09:00 (UTC+8).	00:00Z-01:00Z
CreateTime	string	The time when the cluster was created. The time is in UTC and the format is yyyy-MM-ddTHH:mm:ssZ.	2021-12-13T11:33:11Z
PayType	string	The billing method. Valid values: Postpaid: Pay-as-you-go. Prepaid: Subscription.	Prepaid
Tags	object
Tag	array<object>	The list of tags.
	object	The tag.
Key	string	The key of the tag.	department
Value	string	The value of the tag.	it
PublicConnectionString	string	The public endpoint.	cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com
StorageType	string	The storage class. Valid values: CloudESSD_PL0: ESSD PL0 disk. CloudESSD: ESSD PL1 disk. CloudESSD_PL2: ESSD PL2 disk. CloudESSD_PL3: ESSD PL3 disk. CloudEfficiency: Ultra disk.	CloudESSD
Port	integer	The HTTP port number.	8123
LockMode	string	The lock mode of the cluster. Valid values: Unlock: The cluster is not locked. ManualLock: The cluster is manually locked. LockByExpiration: The cluster is automatically locked upon expiration. LockByRestoration: The cluster is automatically locked before a rollback. LockByDiskQuota: The cluster is automatically locked because the storage is full.	Unlock
Bid	string	The site ID. Valid values: 26842: China site (aliyun.com). 26888: International site (alibabacloud.com).	26842
EngineVersion	string	The engine version.	21.8.10.19
IsExpired	string	Indicates whether the cluster has expired. Valid values: true: Expired. false: Not expired.	false
ScaleOutStatus	object	The data migration status.
Progress	string	The data migration progress in percentage. Note This parameter is returned only when the cluster is in the SCALING_OUT state.	0
Ratio	string	The data migration progress. The format is: Amount of data migrated/Total data amount. Note This parameter is returned only when the cluster is in the SCALING_OUT state.	0MB/60469MB
VpcCloudInstanceId	string	The VPC resource ID.	vpc-bp10tr8k9qasioaty****
DBClusterId	string	The cluster ID.	cc-bp108z124a8o7****
ConnectionString	string	The VPC endpoint.	cc-bp1qx68m06981****.ads.rds.aliyuncs.com
EncryptionKey	string	The KMS key. Note An empty string is returned when the EncryptionType is "off".	685f416f-87c9-4554-8d3a-75b6ce25****
DBClusterType	string	The cluster type. Valid values: Common: a standard cluster. Readonly: a read-only cluster. Guard: a disaster recovery cluster.	Common
CommodityCode	string	The commodity code.	clickhouse_go_public_cn
ExpireTime	string	The expiration time of the cluster. The format is yyyy-MM-ddTHH:mm:ssZ. Note An empty string is returned when the cluster is billed on a pay-as-you-go basis.	2022-11-11T16:00:00Z
DBNodeStorage	integer	The storage space of a single node. Unit: GB. Value range: 100 to 32000. Note The step size is 100 GB.	100
DBNodeClass	string	The cluster specifications. For a single-replica edition, valid values include the following: S4-NEW S8 S16 S32 S64 S104 For a dual-replica edition, valid values include the following: C4-NEW C8 C16 C32 C64 C104	C8
AliUid	string	The Alibaba Cloud account ID.	140692647406****
LockReason	string	The reason for the lock. Note An empty string is returned when the LockMode is Unlock.	DISK_FULL
RegionId	string	The region ID.	cn-hangzhou
PublicPort	string	The public TCP port number.	3306
VSwitchId	string	The vSwitch ID.	vsw-bp1n874li1t5y57wi****
DBClusterStatus	string	The cluster status. Valid values: Preparing: The cluster is being prepared. Creating: The cluster is being created. Running: The cluster is running. Deleting: The cluster is being deleted. SCALING_OUT: The cluster is being scaled out.	Running
DBClusterNetworkType	string	The network type. Only VPC is supported.	vpc
DBClusterDescription	string	The cluster description.	cc-bp108z124a8o7****
ZoneId	string	The zone ID.	cn-hangzhou-h
Category	string	The replica configuration. Valid values: Basic: single-replica edition. HighAvailability: dual-replica edition.	HighAvailability
Engine	string	The engine type.	ClickHouse
SupportMysqlPort	boolean	Indicates whether the MySQL port is supported. Valid values: true: Supported. false: Not supported.	false
SupportHttpsPort	boolean	Indicates whether the HTTPS port is supported. Valid values: true: Supported. false: Not supported.	false
ControlVersion	string	The version of the backend management system. Valid values: v1 v2	v1
PublicIpAddr	string	The IP address for the public connection string.	121.40.xx.xx
VpcIpAddr	string	The IP address for the VPC connection string.	192.168.xx.xx
EngineMinorVersion	string	The current minor version.	1.6.0
EngineLatestMinorVersion	string	The latest minor version to which the cluster can be upgraded.	1.34.0
MaintainAutoType	boolean	The upgrade type. The value false indicates a manual upgrade.	false
ExtStorageType	string	The extended storage type. Valid values: CloudESSD: ESSD PL1 disk. CloudESSD_PL2: ESSD PL2 disk. CloudESSD_PL3: ESSD PL3 disk. CloudEfficiency: ultra disk.	CloudESSD
ExtStorageSize	integer	The extended storage space. Unit: GB.	500
ResourceGroupId	string	The resource group ID.	rg-acfmyf65je6****
ZookeeperClass	string	The Zookeeper specifications.	4 Core 8 GB
AppointmentRestartTime	string	The scheduled restart time. The time is in UTC and the format is YYYY-MM-DDThh:mm:ssZ.	2023-11-06T12:00:00Z
ZoneIdVswitchMap	object	The list of vSwitch IDs for the multi-zone instance.	cn-shanghai-f: vsw-zm0n42d5vvuo****
AvailableUpgradeMajorVersion	object	The major version to which the cluster can be upgraded.	{"MajorVersion":"MinorVersion"}
AppointmentRestartNodeTime	string	The scheduled time to restart a portion of the nodes. The time is in UTC and the format is YYYY-MM-DDThh:mm:ssZ.	2023-11-06T12:00:00Z
AppointmentRestartNodeList	string	The list of nodes scheduled for a restart.	ck-k1a976p3n******--clickhouse-s-0-r-0,ck-k1a976p3n****-**-clickhouse-s-0-r-1
AppointmentElectZookeeperTime	string	The scheduled time for a primary/secondary switchover. The time is in UTC and the format is YYYY-MM-DDThh:mm:ssZ.	2023-11-06T12:00:00Z
AppointmentElectZookeeperDisableWrite	boolean	The configuration for a primary/secondary switchover and restart. Valid values: true: Write operations are stopped for the instance during the switchover. false: Write operations are not stopped for the instance during the switchover.	true
RequestId	string	The request ID.	05321590-BB65-4720-8CB6-8218E041CDD0

Examples

Success response

JSON format

{
  "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"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The DBClusterId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.