DescribeDBInstanceAttribute - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the details of an ApsaraDB for ClickHouse Enterprise Edition 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:DescribeDBInstanceAttribute

get

*EnterpriseDBCluster

acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}

None

Request parameters

Parameter

Type

Required

Description

Example

DBInstanceId

string

Yes

The cluster ID.

cc-bp100p4q1g9z3****

RegionId

string

The region ID.

Valid values:

cn-beijing :
cn-beijing

cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response parameter.
RequestId	string	The request ID.	2FED790E-FB61-4721-8C1C-07C627FA5A19
Data	object	The returned data.
DBInstanceId	string	The cluster ID.	cc-bp100p4q1g9z3****
Description	string	The cluster description.	集群测试
Engine	string	The engine type.	clickhouse
EngineVersion	string	The engine version.	23.8
AliUid	integer	The ID of the Alibaba Cloud account.	140692647406****
Bid	string	The channel ID.	PD39050615820269****
RegionId	string	The region ID.	cn-hangzhou
DeploySchema	string	The deployment method of the cluster. Valid values are single_az and multi_az. single_az: The server is deployed in the primary zone that is specified by the ZoneId parameter. multi_az: The server is deployed in the zones that are specified by the MultiZones parameter. The keeper is always deployed in the zones that are specified by the MultiZones parameter.	single_az
MultiZones	array<object>	The information about the multiple zones.
	object
VSwitchIds	array	An array of vSwitch IDs.
	string	The vSwitch ID.	vsw-bj9kpwhcb9iekphje1ljz
ZoneId	string	The zone ID.	cn-hangzhou-h
ChargeType	string	The billing method. Enterprise Edition clusters are pay-as-you-go.	POSTPAY
Status	string	The instance status.	ACTIVATION
VpcId	string	The VPC ID.	vpc-wz9duj8xd6r1gzhsg*****
VSwitchId	string	The vSwitch ID.	vsw-uf67ij56zm9x4uc6hmilg
ScaleMin	integer	The minimum resources for auto scaling of the serverless cluster.	8
ScaleMax	integer	The maximum resources for auto scaling of the serverless cluster.	32
StorageSize	integer	The storage space. Unit: GB.	12
StorageType	string	The storage type.	100
ObjectStoreSize	string	OSS storage size.	13
ExpireTime	string	The expiration time of the cluster. The time is in the yyyy-MM-ddTHH:mm:ssZ format. Note Pay-as-you-go clusters do not expire. An empty string is returned for pay-as-you-go clusters.	2024-04-17T08:14:48Z
LockMode	string	The lock mode of the cluster.	0
LockReason	string	The reason for the lock.	nolock
MaintainStartTime	string	The start time of the maintenance window.	11:00Z
MaintainEndTime	string	The end time of the maintenance window.	12:00Z
DeletionProtection	boolean	Indicates whether release protection is enabled.	0/1
ResourceGroupId	string	The resource group ID.	rg-acfmzygvt54****
Tags	array<object>	The tag information.
	object	The tag information.
Key	string	The tag key.	id
Value	string	The tag value.	ck
Nodes	array<object>	The node information.
	object	The node information.
ZoneId	string	The zone ID.	cn-hangzhou-h
NodeStatus	string	The running status of the node.	active
CreateTime	string	The creation time of the cluster. The time is in the yyyy-MM-ddTHH:mm:ssZ format.	2023-09-14T08:14:48Z
EngineMinorVersion	string	The minor engine version of the cluster.	23.8.1.41495_6
LatestEngineMinorVersion	string	The latest minor engine version.	23.8.1.41495_6
DisabledPorts	string	The disabled database ports. Multiple ports are separated with commas (,).	9001,8123
ZoneId	string	The zone ID.	cn-hangzhou-h
StorageQuota	string		100
NodeScaleMax	string		32
NodeScaleMin	string		4
NodeCount	string		2
Category	string		enterprise
ClickObserveServiceStatus	string		activation

Examples

Success response

JSON format

{
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627FA5A19",
  "Data": {
    "DBInstanceId": "cc-bp100p4q1g9z3****",
    "Description": "集群测试",
    "Engine": "clickhouse",
    "EngineVersion": "23.8",
    "AliUid": 0,
    "Bid": "PD39050615820269****",
    "RegionId": "cn-hangzhou",
    "DeploySchema": "single_az",
    "MultiZones": [
      {
        "VSwitchIds": [
          "vsw-bj9kpwhcb9iekphje1ljz"
        ],
        "ZoneId": "cn-hangzhou-h"
      }
    ],
    "ChargeType": "POSTPAY",
    "Status": "ACTIVATION",
    "VpcId": "vpc-wz9duj8xd6r1gzhsg*****",
    "VSwitchId": "vsw-uf67ij56zm9x4uc6hmilg",
    "ScaleMin": 8,
    "ScaleMax": 32,
    "StorageSize": 12,
    "StorageType": "100",
    "ObjectStoreSize": "13",
    "ExpireTime": "2024-04-17T08:14:48Z",
    "LockMode": "0",
    "LockReason": "nolock",
    "MaintainStartTime": "11:00Z",
    "MaintainEndTime": "12:00Z",
    "DeletionProtection": true,
    "ResourceGroupId": "rg-acfmzygvt54****",
    "Tags": [
      {
        "Key": "id",
        "Value": "ck"
      }
    ],
    "Nodes": [
      {
        "ZoneId": "cn-hangzhou-h",
        "NodeStatus": "active"
      }
    ],
    "CreateTime": "2023-09-14T08:14:48Z",
    "EngineMinorVersion": "23.8.1.41495_6",
    "LatestEngineMinorVersion": "23.8.1.41495_6",
    "DisabledPorts": "9001,8123",
    "ZoneId": "cn-hangzhou-h",
    "StorageQuota": "100",
    "NodeScaleMax": "32",
    "NodeScaleMin": "4",
    "NodeCount": "2",
    "Category": "enterprise",
    "ClickObserveServiceStatus": "activation"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.