DescribeDBInstanceAttribute-阿里云帮助中心

Call DescribeDBInstanceAttribute to query 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	No	The region ID. You can call the ~~DescribeRegions~~ operation to query the most recent region list. Valid values: cn-beijing : cn-beijing	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response parameters.
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.	cluster test
Engine	string	The engine.	clickhouse
EngineVersion	string	The engine version.	23.8
AliUid	integer	The Alibaba Cloud account ID.	140692647406****
Bid	string	The channel ID.	PD39050615820269****
RegionId	string	The region ID.	cn-hangzhou
DeploySchema	string	The deployment architecture of the cluster. Valid values: `single_az` and `multi_az`. `single_az`: The nodes are deployed in the primary zone specified by `ZoneId`. `multi_az`: The nodes are deployed across the zones specified in `MultiZones`. Keeper nodes are always deployed across the zones specified in `MultiZones`.	single_az
MultiZones	array<object>	The zones for a multi-zone deployment.
	object	Details of a zone.
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 of the cluster. enterprise edition clusters are billed on a pay-as-you-go basis.	POSTPAY
Status	string	The status of the instance.	ACTIVATION
VpcId	string	The VPC ID.	vpc-wz9duj8xd6r1gzhsg*****
VSwitchId	string	The vSwitch ID.	vsw-uf67ij56zm9x4uc6hmilg
ScaleMin	integer	The minimum value for serverless auto scaling.	8
ScaleMax	integer	The maximum value for serverless auto scaling.	32
StorageSize	integer	The storage space, in GB.	12
StorageType	string	The storage type.	100
ObjectStoreSize	string	The storage capacity of Object Storage Service (OSS).	13
ExpireTime	string	The expiration time of the cluster, in `YYYY-MM-DDTHH:mm:ssZ` format. Note Pay-as-you-go clusters do not expire. An empty string is returned.	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	Whether deletion protection is enabled.	0/1
ResourceGroupId	string	The resource group ID.	rg-acfmzygvt54****
Tags	array<object>	The cluster tags.
	object	Details of a tag.
Key	string	The tag key.	id
Value	string	The tag value.	ck
Nodes	array<object>	The cluster nodes.
	object	Details of a node.
ZoneId	string	The zone ID.	cn-hangzhou-h
NodeStatus	string	The status of the node.	active
CreateTime	string	The creation time of the cluster, in `YYYY-MM-DDTHH:mm:ssZ` format.	2023-09-14T08:14:48Z
EngineMinorVersion	string	The minor version of the cluster engine.	23.8.1.41495_6
LatestEngineMinorVersion	string	The latest minor version of the cluster engine.	23.8.1.41495_6
DisabledPorts	string	A comma-separated list of disabled database ports.	9001,8123
ZoneId	string	The zone ID.	cn-hangzhou-h
StorageQuota	string	The provisioned storage, in GB.	100
NodeScaleMax	string	The maximum number of nodes for auto scaling of a serverless cluster.	32
NodeScaleMin	string	The minimum number of nodes for auto scaling of a serverless cluster.	4
NodeCount	string	The number of nodes.	2
Category	string	The edition of the cluster. Valid value: `enterprise`: enterprise edition	enterprise
ClickObserveServiceStatus	string	The status of the ClickObserve service.	activation
LangfuseInstanceIds	array	A list of Langfuse instance IDs.
	string	The Langfuse instance ID.	lfs-2ze172q******
WebUISnatStatus	string		active

Examples

Success response

JSON format

{
  "RequestId": "2FED790E-FB61-4721-8C1C-07C627FA5A19",
  "Data": {
    "DBInstanceId": "cc-bp100p4q1g9z3****",
    "Description": "cluster test",
    "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",
    "LangfuseInstanceIds": [
      "lfs-2ze172q******"
    ],
    "WebUISnatStatus": "active"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.