DescribeDBClusterAttribute-阿里云帮助中心

Retrieves details for a specific 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 the details of all clusters in a region, including their IDs.	cc-bp108z124a8o7****

Response elements

Element	Type	Description	Example
	object	The data returned.
DBCluster	object	Details about the cluster.
VpcId	string	The VPC ID.	vpc-bp10tr8k9qasioaty****
SupportBackup	integer	Whether the cluster supports data backup. Valid values: `1`: Supported. `2`: Not supported.	1
SupportOss	integer	Whether the cluster supports tiered storage for hot and cold data. 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 in the cluster. For a single-replica edition, the value range is 1 to 48. For a dual-replica edition, the value range is 1 to 24.	1
MaintainTime	string	The maintenance window of the cluster. The time is in the `HH:mmZ-HH:mmZ` format and is in UTC. For example, `00:00Z-01:00Z` indicates that the maintenance window is from 00:00 to 01:00 (UTC), which corresponds to 08:00 to 09:00 in Beijing time (UTC+8).	00:00Z-01:00Z
CreateTime	string	The creation time of the cluster, in `yyyy-MM-ddTHH:mm:ssZ` format (UTC).	2021-12-13T11:33:11Z
PayType	string	The billing method. Valid values: `Postpaid`: pay-as-you-go. `Prepaid`: subscription.	Prepaid
Tags	object	The tags of the cluster.
Tag	array<object>	A list of tags.
	object	A tag object.
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 type. 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.	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	Whether the cluster has expired. Valid values: `true`: The cluster has expired. `false`: The cluster has not expired.	false
ScaleOutStatus	object	The data migration status.
Progress	string	The data migration progress, as a percentage. Note This parameter is returned only when the cluster is in the `SCALING_OUT` state.	0
Ratio	string	The data migration progress, displayed as `Amount of data migrated/Total data amount`. Note This parameter is returned only when the cluster is in the `SCALING_OUT` state.	0MB/60469MB
LbKind	string	The type of the load balancer.	clb
DBClusterId	string	The cluster ID.	cc-bp108z124a8o7****
ConnectionString	string	The VPC endpoint.	cc-bp1qx68m06981****.ads.rds.aliyuncs.com
EncryptionKey	string	The Key Management Service (KMS) key ID. Note This parameter is empty if `EncryptionType` is set to `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, in `yyyy-MM-ddTHH:mm:ssZ` format (UTC). Note This parameter is empty for pay-as-you-go clusters.	2022-11-11T16:00:00Z
DBNodeStorage	integer	The storage capacity per node, in GB. The value can range from 100 to 32000. Note The value must be a multiple of 100.	100
DBNodeClass	string	The instance type of the cluster nodes. Valid values for a single-replica edition: `S4-NEW` `S8` `S16` `S32` `S64` `S104` Valid values for a dual-replica edition: `C4-NEW` `C8` `C16` `C32` `C64` `C104`	C8
AliUid	string	The Alibaba Cloud account ID.	140692647406****
LockReason	string	The reason the cluster was locked. Note This parameter is empty if `LockMode` is set to `Unlock`.	DISK_FULL
RegionId	string	The region ID.	cn-hangzhou
PublicPort	string	The public TCP port.	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 edition of the cluster. Valid values: `Basic`: single-replica edition. `HighAvailability`: dual-replica edition.	HighAvailability
Engine	string	The database engine.	ClickHouse
SupportMysqlPort	boolean	Whether the MySQL port is supported. Valid values: `true`: Supported. `false`: Not supported.	false
SupportHttpsPort	boolean	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 of the public endpoint.	121.40.xx.xx
EngineMinorVersion	string	The engine's 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 method. A value of `false` indicates that upgrades must be performed manually.	false
ExtStorageType	string	The extended storage type. 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
ExtStorageSize	integer	The extended storage capacity, in GB.	500
ResourceGroupId	string	The resource group ID.	rg-acfmyf65je6****
ZookeeperClass	string	The specifications of the ZooKeeper nodes.	4 Core 8 GB
AppointmentRestartTime	string	The scheduled restart time. The time is in the `YYYY-MM-DDThh:mm:ssZ` format and is in UTC.	2023-11-06T12:00:00Z
ZoneIdVswitchMap	object	A map of zone IDs to vSwitch IDs for a multi-zone cluster.	cn-shanghai-f: vsw-zm0n42d5vvuo****
AvailableUpgradeMajorVersion	object	The available major versions to which the cluster can be upgraded, and their latest minor versions.	{"MajorVersion":"MinorVersion"}
AppointmentRestartNodeTime	string	The scheduled time to restart specific nodes. The time is in the `YYYY-MM-DDThh:mm:ssZ` format and is in UTC.	2023-11-06T12:00:00Z
AppointmentRestartNodeList	string	A list of nodes that are 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 the `YYYY-MM-DDThh:mm:ssZ` format and is in UTC.	2023-11-06T12:00:00Z
AppointmentElectZookeeperDisableWrite	boolean	Specifies whether to stop write operations during a primary/secondary switchover. 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
VpcIpAddr	string	The IP address of the VPC endpoint.	192.168.xx.xx
VpcCloudInstanceId	string	The VPC ID.	vpc-bp10tr8k9qasioaty****
WebUIStatus	string		active
WebUISnatStatus	string		active
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"
    },
    "LbKind": "clb",
    "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",
    "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,
    "VpcIpAddr": "192.168.xx.xx",
    "VpcCloudInstanceId": "vpc-bp10tr8k9qasioaty****",
    "WebUIStatus": "active",
    "WebUISnatStatus": "active"
  },
  "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.