DescribeDBClusterAttribute-阿里云帮助中心

Queries the details of a specified AnalyticDB for MySQL 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

adb:DescribeDBClusterAttribute

get

DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster. Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters in a specified region.	am-bp111m2cfrdl1****
RegionId	string	No	The region ID of the cluster.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The list details.
RequestId	string	The request ID.	2895BB82-B2C1-408E-AA73-DB8D59******
Items	object
DBCluster	array<object>	The list of cluster information.
	array<object>	The cluster details.
CreationTime	string	The creation time of the cluster. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2021-04-01T09:50:18Z
EnableSpark	boolean	Indicates whether a Spark cluster is created. Valid values: true: A Spark cluster is created. false: No Spark cluster is created.	false
DtsJobId	string	The ID of the Data Transmission Service (DTS) synchronization task. This parameter is returned only for MySQL analytical instances. For more information, see Introduction to MySQL analytical instances.	dtsb1hp3790****
DBNodeCount	integer	The number of node groups.	1
Expired	string	Indicates whether the cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired.	false
MaintainTime	string	The maintenance window of the cluster. The time is displayed in the HH:mmZ-HH:mmZ format. For example, 04:00Z-05:00Z indicates that the maintenance window is from 04:00 to 05:00. Note For more information about the maintenance window, see Set the maintenance window.	04:00Z-05:00Z
PayType	string	The billing method of the cluster. Valid values: Postpaid: Pay-as-you-go. Prepaid: Subscription.	Postpaid
DiskType	string	The disk type of the cluster. Valid values: local_ssd: Local disk. cloud: Basic cloud disk. cloud_ssd: Standard SSD. cloud_efficiency: Ultra disk. cloud_essd0: PL0 ESSD. cloud_essd: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. Note For more information about ESSDs, see ESSD specifications.	cloud_essd
Tags	object
Tag	array<object>	The list of tags.
	object	The cluster details.
Key	string	The tag key. Note You can call the TagResources operation to create tags for the cluster.	tag1
Value	string	The tag value.	test1
Mode	string	The cluster mode. Valid values: flexible: Elastic mode. reserver: Reserved mode. Note For more information about cluster modes, see Editions.	flexible
Port	integer	The port number of the cluster.	3306
LockMode	string	The lock mode of the cluster. Valid values: Unlock: Normal (unlocked). ManualLock: Manually locked. LockByExpiration: Automatically locked due to expiration. LockByRestoration: Automatically locked before a rollback. LockByDiskQuota: Automatically locked because the storage space is full (the storage space used by data has reached 90% of the upper limit).	Unlock
EngineVersion	string	The DPI engine version of the cluster.	3.1.1.9
EnableAirflow	boolean	Indicates whether an Airflow cluster is created. Valid values: true: An Airflow cluster is created. false: No Airflow cluster is created.	true
ExecutorCount	string	The number of compute nodes used by the cluster in elastic mode.	1
StorageResource	string	The storage resource specifications used in elastic mode for data reads and writes. Increasing this resource improves the read and write capabilities of the cluster.	8Core32GB
DBClusterId	string	The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.	am-bp111m2cfrdl1****
ConnectionString	string	The VPC endpoint of the cluster.	am-bp111m2cfrdl1****.ads.aliyuncs.com
RdsInstanceId	string	The source ApsaraDB RDS instance ID for synchronization. This parameter is returned only for MySQL analytical instances. For more details, see Introduction to MySQL analytical instances.	rm-bp837jsdp2****
DBClusterType	string	The cluster type. Valid values: Common: Common cluster. RDS_ANALYSIS: MySQL analytical instance. For more information, see Introduction to MySQL analytical instances.	Common
CommodityCode	string	The billing method of the commodity. Valid values: ads: Pay-as-you-go commodity. ads_pre: Subscription commodity.	ads
ExpireTime	string	The expiration time of the cluster. The time is displayed in the yyyy-MM-ddTHH:mm:ssZ format (UTC), such as 2999-09-08T16:00:00Z. Note If the cluster uses the subscription billing method, the actual expiration time is returned. If the cluster uses the pay-as-you-go billing method, the fixed value 2999-09-08T16:00:00Z is returned.	2999-09-08T16:00:00Z
DBNodeStorage	integer	The storage space of the cluster. Unit: GB.	300
DBNodeClass	string	The node specifications.	E8
LockReason	string	The reason why the cluster is locked. Note This parameter is returned only when the cluster is locked. The value is fixed as instance_expire.	instance_expired
VPCId	string	The virtual private cloud (VPC) ID.	vpc-bp13h7uzhulpuxvnp****
ComputeResource	string	The compute resource specifications used in elastic mode for data computing. Increasing compute resources accelerates query speeds. You can scale the compute resources elastically based on the actual performance requirements of the cluster.	8Core32GB
RegionId	string	The region ID of the cluster.	cn-hangzhou
ElasticIOResource	integer	The number of elastic I/O resources.	2
VSwitchId	string	The vSwitch ID.	vsw-bp1syh8vvw8yech7n****
DBVersion	string	The database version. Only version 3.0 is supported.	3.0
VPCCloudInstanceId	string	The VPC-connected instance ID.	am-bp111m2cfrdl1****-controller
DBClusterStatus	string	The cluster status. For more information, see Cluster status table.	Running
ResourceGroupId	string	The resource group ID.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	The network type of the cluster. Only VPC is supported.	vpc
DBClusterDescription	string	The description of the cluster.	adb_test
UserENIStatus	boolean	Indicates whether the elastic network interface controller (NIC) network is enabled. Valid values: true: The ENI network is enabled. false: The ENI network is disabled.	true
ZoneId	string	The zone ID of the cluster.	cn-hangzhou-h
Category	string	The edition. Valid values: BASIC: Basic Edition in reserved mode. CLUSTER: Cluster Edition in reserved mode. MIXED_STORAGE: Cluster Edition in elastic mode (new version). Note For more information about editions, see Editions.	MIXED_STORAGE
Engine	string	The cluster engine. The value is fixed as AnalyticDB.	AnalyticDB
KmsId	string	The ID of the key used to encrypt cloud disk data. Note This parameter is returned only when cloud disk encryption is enabled for the AnalyticDB for MySQL cluster.	e1935511-cf88-1123-a0f8-1be8d251****
InnerIp	string	The public IP address.	10.1.XX.XX
InnerPort	string	The public port number.	3306
DiskPerformanceLevel	string	The cloud disk performance level.	PL1
ElasticIOResourceSize	string	The single-node specifications of elastic resources. Valid values: 8Core64GB: When the single-node specifications are 8 cores and 64 GB, the specifications of a group of elastic I/O resources are 24 cores and 192 GB. 12Core96GB: When the single-node specifications are 12 cores and 96 GB, the specifications of a group of elastic I/O resources are 36 cores and 288 GB.	8Core64GB
DiskEncryption	boolean	Indicates whether cloud disk encryption is enabled. Valid values: true: Cloud disk encryption is enabled. false: Cloud disk encryption is disabled.	false
TaskInfo	object	The task information.
Name	string	The task name.	analyticDBFlexibleScaleOut
Status	string	The task status. Valid values: NOT_RUN: Pending. RUNNING: Running. SUCCEED: Completed. Valid values: SUCCEED : Completed. RUNNING : Running. NOT_RUN : Pending.	RUNNING
Progress	string	The task progress. Unit: %.	10
StepList	object
StepList	array<object>	The task steps.
	object	The task steps.
StepName	string	The step name.	ApplyResource
StepDesc	string	The step description.	Apply resource
StepStatus	string	The step status. Valid values: NOT_RUN: Pending. RUNNING: Running. SUCCEED: Completed. Valid values: SUCCEED : Completed. RUNNING : Running. NOT_RUN : Pending.	SUCCEED
StepProgress	string	The step progress. Unit: %.	50
StartTime	string	The start time of the step. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.	2024-03-10T09:28:34Z
EndTime	string	The end time of the step. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.	2024-03-10T10:28:34Z
ProductVersion	string	The product edition. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	BasicVersion
SecondaryZoneId	string	The secondary zone ID. Note The value of this parameter cannot be the same as the value of the ZoneId parameter.	cn-hangzhou-i
SecondaryVSwitchId	string	The secondary vSwitch ID. Note The value of this parameter cannot be the same as the value of the VSwitchId parameter.	vsw-0jlxwqt4531fsb3jdzx6h
ReservedNodeSize	string	The reserved node specifications. Unit: ACU.	8ACU
ReservedNodeCount	integer	The number of reserved resource nodes.	3
ProductForm	string	The product form. Valid values: LegacyForm: Legacy form. IntegrationForm: Integration form. Valid values: LegacyForm : Legacy form. IntegrationForm : Integration form.	IntegrationForm

Examples

Success response

JSON format

{
  "RequestId": "2895BB82-B2C1-408E-AA73-DB8D59******",
  "Items": {
    "DBCluster": [
      {
        "CreationTime": "2021-04-01T09:50:18Z",
        "EnableSpark": false,
        "DtsJobId": "dtsb1hp3790****",
        "DBNodeCount": 1,
        "Expired": "false",
        "MaintainTime": "04:00Z-05:00Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": 3306,
        "LockMode": "Unlock",
        "EngineVersion": "3.1.1.9",
        "EnableAirflow": true,
        "ExecutorCount": "1",
        "StorageResource": "8Core32GB",
        "DBClusterId": "am-bp111m2cfrdl1****",
        "ConnectionString": "am-bp111m2cfrdl1****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp837jsdp2****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "ComputeResource": "8Core32GB",
        "RegionId": "cn-hangzhou",
        "ElasticIOResource": 2,
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp111m2cfrdl1****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "UserENIStatus": true,
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "InnerIp": "10.1.XX.XX",
        "InnerPort": "3306",
        "DiskPerformanceLevel": "PL1",
        "ElasticIOResourceSize": "8Core64GB",
        "DiskEncryption": false,
        "TaskInfo": {
          "Name": "analyticDBFlexibleScaleOut",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "ApplyResource",
                "StepDesc": "Apply resource",
                "StepStatus": "SUCCEED",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "ProductVersion": "BasicVersion",
        "SecondaryZoneId": "cn-hangzhou-i",
        "SecondaryVSwitchId": "vsw-0jlxwqt4531fsb3jdzx6h",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 3,
        "ProductForm": "IntegrationForm"
      }
    ]
  }
}

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.