DescribeDBClusterAttribute-阿里云帮助中心

Returns the details of a specific cluster.

Operation description

To find the endpoints for this service, see Endpoints.

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

adb:DescribeDBClusterAttribute

get

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of an Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster. Note You can call the DescribeDBClusters operation to obtain the cluster ID.	amv-wz9509beptiz****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	A5C433C2-001F-58E3-99F5-3274C14DF8BD
Items	object
DBCluster	array<object>	The information about the Enterprise Edition and Basic Edition clusters.
	array<object>	The details of the cluster.
CreationTime	string	The time when the cluster was created. The time is in the `yyyy-MM-ddThh:mm:ssZ` format and is displayed in UTC.	2022-07-01T09:50:18Z
Expired	string	Indicates whether the subscription cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired. Note If a cluster expires, the cluster is locked or even released after a period of time. We recommend that you renew the cluster. For more information, see Renewal. This parameter is not returned for pay-as-you-go clusters.	false
MaintainTime	string	The maintenance window of the cluster. The time is in the `HH:mmZ-HH:mmZ` format and is displayed in UTC. Note For more information about maintenance windows, see Set a maintenance window.	04:00Z-05:00Z
PayType	string	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
Tags	object
Tag	array<object>	The list of tags.
	object
Key	string	The tag key. Note To add tags to the cluster, call the TagResources operation.	tag1
Value	string	The tag value.	test1
Mode	string	The mode of the cluster. The default value is flexible, which indicates an elastic mode cluster.	flexible
Port	integer	The port number of the cluster.	3306
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 due to expiration.	ManualLock
EngineVersion	string	The engine version of the cluster.	3.1.16
StorageResource	string	The amount of reserved storage resources. These resources are used for data reads and writes. Increasing them can improve the cluster's read and write performance.	24ACU
DBClusterId	string	The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.	amv-wz9509beptiz****
ConnectionString	string	The VPC endpoint of the cluster.	amv-wz9509beptiz****.ads.aliyuncs.com
DBClusterType	string	The type of the cluster. The default value is Common, which indicates a regular cluster.	Common
CommodityCode	string	The commodity code of the cluster, which is the same as the code of the cluster on the Billing Management page. Valid values: ads: A pay-as-you-go cluster. ads_pre: A subscription cluster.	ads_pre
ExpireTime	string	The expiration time of the cluster. If the cluster is a subscription cluster, the expiration time is returned. If the cluster is a pay-as-you-go cluster, an empty string is returned.	2022-10-01T09:50:18Z
LockReason	string	The reason why the cluster is locked. Note This parameter is returned only when the cluster is locked. The value is always instance_expire.	instance_expire
VPCId	string	The Virtual Private Cloud (VPC) ID.	vpc-bp13h7uzhulpu****
ComputeResource	string	The amount of reserved computing resources. One AnalyticDB Compute Unit (ACU) is equivalent to approximately 1 core and 4 GB of memory. Computing resources are used for data computation. Increasing these resources can accelerate queries. You can scale the resources on demand based on the actual performance of the cluster.	16ACU
RegionId	string	The region ID of the cluster.	cn-hangzhou
VSwitchId	string	The vSwitch ID.	vsw-uf629gydd54ld****
DBVersion	string	The version of the AnalyticDB for MySQL cluster. Currently, only version 5.0 is supported.	5.0
DBClusterStatus	string	The status of the cluster. 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. Restoring: The cluster is being restored from a backup. ClassChanging: The cluster specifications are being changed. NetAddressCreating: A network connection is being created. NetAddressDeleting: A network connection is being deleted. NetAddressModifying: A network connection is being modified.	Running
ResourceGroupId	string	The resource group ID.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	The network type of the cluster. Only VPC (Virtual Private Cloud) is supported.	VPC
DBClusterDescription	string	The description of the cluster.	adb_test
UserENIStatus	boolean	Indicates whether an elastic network interface (ENI) is enabled. Valid values: true: An ENI is enabled. false: An ENI is not enabled.	false
ZoneId	string	The zone ID of the cluster.	cn-hangzhou-h
Engine	string	The database engine of the cluster. The value is always AnalyticDB.	AnalyticDB
ReservedACU	string	The amount of available reserved computing resources in the cluster.	24ACU
ComputeResourceTotal	string	The total amount of computing resources in the cluster.	48ACU
StorageResourceTotal	string	The total amount of storage resources in the cluster.	24ACU
SupportedFeatures	object	This parameter is reserved for future use.
	string	This parameter is reserved for future use.	预留参数，不涉及。
ProductForm	string	This parameter is reserved for future use.	预留参数，不涉及。
ReservedNodeSize	string	This parameter is reserved for future use.	预留参数，不涉及。
ReservedNodeCount	integer	This parameter is reserved for future use.	预留参数，不涉及。
ClickhouseEngineEnabled	boolean	Indicates whether the ClickHouse wide table engine is enabled. true: The ClickHouse wide table engine is enabled. false: The ClickHouse wide table engine is not enabled. Valid values: true : true false : false	true
AINodeNumber	integer	The number of AI nodes.	3
ProductVersion	string	The product version of the cluster. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	BasicVersion
KmsId	string	The key ID used for disk encryption. Note This parameter is returned only when disk encryption is enabled for the AnalyticDB for MySQL cluster.	e1935511-cf88-1123-a0f8-1be8d251****
TaskInfo	object	The task information.
Name	string	The name of the task.	ScaleUpDBCluster
Status	string	The status of the task. Valid values: NOT_RUN: The task is waiting to run. RUNNING: The task is running. SUCCEED: The task is complete.	RUNNING
Progress	string	The progress of the task, in percentage.	10
StepList	object
StepList	array<object>	The steps of the task.
	object	The details of a step.
StepName	string	The name of the step.	PrepareResources
StepDesc	string	The description of the step.	Prepare resources
StepStatus	string	The status of the step. Valid values: NOT_RUN: The step is waiting to run. RUNNING: The step is running. SUCCEED: The step is complete.	RUNNING
StepProgress	string	The progress of the step, in percentage.	50
StartTime	string	The start time of the step. The time is in the `yyyy-MM-ddThh:mm:ssZ` format and is displayed in UTC.	2024-03-10T09:28:34Z
EndTime	string	The end time of the step. The time is in the `yyyy-MM-ddThh:mm:ssZ` format and is displayed in UTC.	2024-03-10T10:28:34Z
UserENIVpcId	string	The VPC information of the ENI.	vpc-rj9hnedlfm645uj******
UserENIVSwitchOptions	string	The vSwitch IDs for the ENI. Multiple IDs are separated by commas (,).	vsw-rj9ixufmywqq98z****,vsw-rj95ij6wcz656v7****
UserENIZoneOptions	string	The zone IDs for the ENI. Multiple IDs are separated by commas (,).	cn-hangzhou-k,cn-hangzhou-h
SecondaryZoneId	string	The ID of the secondary zone.	cn-hangzhou-k
SecondaryVSwitchId	string	The ID of the secondary vSwitch.	vsw-8vbl7kfaxxxxx
DiskEncryption	boolean	Indicates whether disk encryption is enabled. Valid values: true: Disk encryption is enabled. false: Disk encryption is not enabled.	false
ClickhouseEngineCacheSize	integer	The cache size of the ClickHouse wide table engine, in GB. A value of -1 indicates that the wide table engine is disabled.	100
AINodeSpec	string	The specifications of the AI nodes.	ADB.MLGrand.5

Examples

Success response

JSON format

{
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD",
  "Items": {
    "DBCluster": [
      {
        "CreationTime": "2022-07-01T09:50:18Z",
        "Expired": "false",
        "MaintainTime": "04:00Z-05:00Z",
        "PayType": "Prepaid",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": 3306,
        "LockMode": "ManualLock",
        "EngineVersion": "3.1.16",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-wz9509beptiz****",
        "ConnectionString": "amv-wz9509beptiz****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-10-01T09:50:18Z",
        "LockReason": "instance_expire",
        "VPCId": "vpc-bp13h7uzhulpu****",
        "ComputeResource": "16ACU",
        "RegionId": "cn-hangzhou",
        "VSwitchId": "vsw-uf629gydd54ld****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "UserENIStatus": false,
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "24ACU",
        "ComputeResourceTotal": "48ACU",
        "StorageResourceTotal": "24ACU",
        "SupportedFeatures": {
          "key": "预留参数，不涉及。"
        },
        "ProductForm": "预留参数，不涉及。",
        "ReservedNodeSize": "预留参数，不涉及。",
        "ReservedNodeCount": 0,
        "ClickhouseEngineEnabled": true,
        "AINodeNumber": 3,
        "ProductVersion": "BasicVersion",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "TaskInfo": {
          "Name": "ScaleUpDBCluster",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "PrepareResources",
                "StepDesc": "Prepare resources",
                "StepStatus": "RUNNING",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "UserENIVpcId": "vpc-rj9hnedlfm645uj******",
        "UserENIVSwitchOptions": "vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******",
        "UserENIZoneOptions": "cn-hangzhou-k,cn-hangzhou-h",
        "SecondaryZoneId": "cn-hangzhou-k",
        "SecondaryVSwitchId": "vsw-8vbl7kfaxxxxx",
        "DiskEncryption": false,
        "ClickhouseEngineCacheSize": 100,
        "AINodeSpec": "ADB.MLGrand.5"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.