All Products
Search

This Product

    ApsaraDB for ClickHouse:DescribeDBClusterAttribute

    Document Center

    ApsaraDB for ClickHouse:DescribeDBClusterAttribute

    Last Updated:Jul 17, 2024

    Queries the information about an ApsaraDB for ClickHouse cluster.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The cluster ID. You can call the DescribeDBClusters operation to query information about all the clusters that are deployed in a specific region. The information includes the cluster IDs.

    		cc-bp108z124a8o7****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    DBClusterobject

    The information about the cluster.

    VpcIdstring

    The virtual private cloud (VPC) ID.

    		vpc-bp10tr8k9qasioaty****
    SupportBackupinteger

    Indicates whether data backup is supported. Valid values:

    • 1: Data backup is supported.
    • 2: Data backup is not supported.
    		1
    SupportOssinteger

    Indicates whether tiered storage of hot data and cold data is supported. Valid values:

    • 1: Tiered storage of hot data and cold data is supported.
    • 2: Tiered storage of hot data and cold data is not supported.
    		1
    EncryptionTypestring

    The encryption type. Valid values:

    • CloudDisk: Disk encryption is enabled.
    • off: Data is not encrypted.
    		CloudDisk
    DBNodeCountlong

    The number of nodes.

    • Valid values when the cluster is of Single-replica Edition: 1 to 48.
    • Valid values when the cluster is of Double-replica Edition: 1 to 24.
    		1
    MaintainTimestring

    The maintenance window of the cluster. The value is in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.

    For example, if you set the maintenance window to 00:00Z-01:00Z, the cluster can be maintained from 08:00 (UTC+8) to 09:00 (UTC+8).

    		00:00Z-01:00Z
    CreateTimestring

    The time when the cluster was created. The value is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		2021-12-13T11:33:11Z
    PayTypestring

    The billing method of the cluster. Valid values:

    • Postpaid: indicates the pay-as-you-go billing method.
    • Prepaid: indicates the subscription billing method.
    		Prepaid
    Tagsarray<object>

    The tags.

    object
    Keystring

    The tag name.

    		department
    Valuestring

    The tag value.

    		it
    PublicConnectionStringstring

    The public endpoint.

    		cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com
    StorageTypestring

    The storage type of the cluster. Valid values:

    • CloudESSD: The cluster uses an enhanced SSD (ESSD) of performance level (PL) 1.
    • CloudESSD_PL2: The cluster uses an ESSD of PL 2.
    • CloudESSD_PL3: The cluster uses an ESSD of PL 3.
    • CloudEfficiency: The cluster uses an ultra disk.
    		CloudESSD
    Portinteger

    The HTTP port number.

    		8123
    LockModestring

    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 due to cluster expiration.
    • LockByRestoration: The cluster is automatically locked because the cluster is about to be rolled back.
    • LockByDiskQuota: The cluster is automatically locked because the disk space is exhausted.
    		Unlock
    Bidstring

    The site ID. Valid values:

    • 26842: the China site (aliyun.com)
    • 26888: the international site (alibabacloud.com)
    		26842
    EngineVersionstring

    The engine version.

    		21.8.10.19
    IsExpiredstring

    Indicates whether the cluster has expired. Valid values:

    • true
    • false
    		false
    ScaleOutStatusobject

    The status of the data migration task.

    Progressstring

    The progress of the data migration task in percentage.

    Note This parameter is returned only when the cluster is in the SCALING_OUT state.
    		0
    Ratiostring

    The progress of the data migration task. This value is displayed in the following format: Data volume that has been migrated/Total data volume.

    Note This parameter is returned only when the cluster is in the SCALING_OUT state.
    		0MB/60469MB
    VpcCloudInstanceIdstring

    The ID of the VPC in which the cluster is deployed.

    		vpc-bp10tr8k9qasioaty****
    DBClusterIdstring

    The cluster ID.

    		cc-bp108z124a8o7****
    ConnectionStringstring

    The VPC endpoint of the cluster.

    		cc-bp1qx68m06981****.ads.rds.aliyuncs.com
    EncryptionKeystring

    The Key Management Service (KMS) key that is used to encrypt data.

    Note If the value of the EncryptionType parameter is off, an empty string is returned for this parameter.
    		685f416f-87c9-4554-8d3a-75b6ce25****
    DBClusterTypestring

    The type of the cluster. Valid values:

    • Common: a common cluster
    • Readonly: a read-only cluster
    • Guard: a disaster recovery cluster
    		Common
    CommodityCodestring

    The commodity code of the cluster.

    		clickhouse_go_public_cn
    ExpireTimestring

    The time when the cluster expired. The time is in the yyyy-MM-ddTHH:mm:ssZ format.

    Note Pay-as-you-go clusters never expire. If the cluster is a pay-as-you-go cluster, an empty string is returned for this parameter.
    		2022-11-11T16:00:00Z
    DBNodeStoragelong

    The storage capacity of a single node of the cluster. Unit: GB.

    Valid values: 100 to 32000.

    Note This value is a multiple of 100.
    		100
    DBNodeClassstring

    The specifications of the cluster.

    • Valid values when the cluster is of Single-replica Edition:

      • S4-NEW
      • S8
      • S16
      • S32
      • S64
      • S104

    • Valid values when the cluster is of Double-replica Edition:

      • C4-NEW
      • C8
      • C16
      • C32
      • C64
      • C104
    		C8
    AliUidstring

    The ID of the Alibaba Cloud account.

    		140692647406****
    LockReasonstring

    The cause why the cluster was locked.

    Note If the value of the LockMode parameter is Unlock, an empty string is returned for this parameter.
    		DISK_FULL
    RegionIdstring

    The region ID.

    		cn-hangzhou
    PublicPortstring

    The TCP port number in the public endpoint.

    		3306
    VSwitchIdstring

    The vSwitch ID.

    		vsw-bp1n874li1t5y57wi****
    DBClusterStatusstring

    The cluster state. 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 storage capacity of the cluster is being expanded.
    		Running
    DBClusterNetworkTypestring

    The network type of the cluster. Only VPC is supported.

    		vpc
    DBClusterDescriptionstring

    The description of the cluster.

    		cc-bp108z124a8o7****
    ZoneIdstring

    The zone ID.

    		cn-hangzhou-h
    Categorystring

    The edition of the cluster. Valid values:

    • Basic: Single-replica Edition
    • HighAvailability: Double-replica Edition
    		HighAvailability
    Enginestring

    The type of the database engine.

    		ClickHouse
    SupportMysqlPortboolean

    Indicates whether the cluster supports a MySQL port. Valid values:

    • true: A MySQL port is supported.
    • false: A MySQL port is not supported.
    		false
    SupportHttpsPortboolean

    Indicates whether HTTPS ports are supported. Valid values:

    • true
    • false
    		false
    ControlVersionstring

    The version of the ApsaraDB for ClickHouse console that is used to manage the cluster. Valid values:

    • v1
    • v2
    		v1
    PublicIpAddrstring

    The IP address that is used to connect to the cluster over the Internet.

    		121.40.xx.xx
    VpcIpAddrstring

    The IP address that is used to connect to the cluster over the VPC.

    		192.168.xx.xx
    EngineMinorVersionstring

    The current minor version.

    		1.6.0
    EngineLatestMinorVersionstring

    The latest minor version to which the cluster can be updated.

    		1.34.0
    MaintainAutoTypeboolean

    The update type. If the value of the parameter is false, it indicates a manual update.

    		false
    ExtStorageTypestring

    The extended storage type. Valid values:

    • CloudESSD: The cluster uses an enhanced SSD (ESSD) of performance level (PL) 1.
    • CloudESSD_PL2: The cluster uses an ESSD of PL 2.
    • CloudESSD_PL3: The cluster uses an ESSD of PL 3.
    • CloudEfficiency: The cluster uses an ultra disk.
    		CloudESSD
    ExtStorageSizeinteger

    The extended storage space. Unit: GB.

    		500
    ResourceGroupIdstring

    The resource group ID.

    		rg-acfmyf65je6****
    ZookeeperClassstring

    The ZooKeeper specifications.

    		4 Core 8 GB
    AppointmentRestartTimestring

    The scheduled restart time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).

    		2023-11-06T12:00:00Z
    ZoneIdVswitchMapobject

    The list of vSwitch IDs in multi-zone clusters.

    		cn-shanghai-f: vsw-zm0n42d5vvuo****
    RequestIdstring

    The request ID.

    		05321590-BB65-4720-8CB6-8218E041CDD0

    Examples

    Sample success responses

    JSONformat

    {
  "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
    }
  },
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0"
}

    Error codes

    HTTP status codeError codeError messageDescription
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The DBClusterId provided does not exist in our records.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-12-08The Error code has changed. The response structure of the API has changedView Change Details
    2023-03-23The Error code has changed. The response structure of the API has changedView Change Details
    2022-02-24The Error code has changed. The response structure of the API has changedView Change Details