DescribeDBClusterAttribute - Developer‘s Guide| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBClusterAttribute	The operation that you want to perform. Set the value to DescribeDBClusterAttribute.
DBClusterId	String	Yes	am-bp***************	The ID of the cluster. Note You can call the DescribeDBClusters operation to query the details of all AnalyticDB for MySQL clusters within a specified region, including cluster IDs.

Response parameters


Parameter	Type	Example	Description
RequestId	String	2895BB82-B2C1-408E-AA73-DB8D59******	The ID of the request.
Items	Array of DBCluster		Details about the clusters.
DBCluster
CreationTime	String	2021-04-01T09:50:18Z	The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Example: 2021-04-01T09:50:18Z.
EnableSpark	Boolean	false	Indicates whether a Spark cluster was created. Valid values: true: A Spark cluster was created. false: No Spark cluster was created.
DtsJobId	String	dtsb1***********	The ID of the Data Transmission Service (DTS) synchronization task. This parameter is returned only for MySQL analytic instances.
DBNodeCount	Long	1	The number of node groups.
Expired	String	false	Indicates whether the cluster has expired. Valid values: true: The cluster has expired. false: The cluster has not expired.
MaintainTime	String	04:00Z-05:00Z	The maintenance window of the cluster. The time follows the ISO 8601 standard in the HH:mmZ- HH:mmZ format. The time is displayed in UTC. An example is 04:00Z-05:00Z, which indicates that routine maintenance can be performed from 04:00 to 05:00. Note For more information about the maintenance window, see Set a maintenance window.
PayType	String	Postpaid	The billing method of the cluster. Valid values: Postpaid: pay-as-you-go Prepaid: subscription
DiskType	String	cloud_essd	The type of the disk. Valid values: local_ssd: local disk cloud: basic disk cloud_ssd: standard SSD cloud_efficiency: ultra disk cloud_essd: enhanced SSD (ESSD) at performance level 1 (PL1) cloud_essd2: ESSD at performance level 2 (PL2) cloud_essd3: ESSD at performance level 3 (PL3) Note For more information about ESSDs, see ESSDs.
Tags	Array of Tag		Details about the tags.
Tag
Key	String	tag1	The key of the tag. Note You can call the TagResources operation to add a tag to the cluster.
Value	String	test1	The value of the tag.
Mode	String	flexible	The mode of the cluster. Valid values: flexible: the elastic mode reserver: the reserved mode Note For more information about cluster modes, see Editions.
Port	Integer	3306	The port number that is used to connect to the cluster. Default value: 3306.
LockMode	String	Unlock	The lock mode of the cluster. Valid values: Unlock: The cluster has not been locked. ManualLock: The cluster has been manually locked. LockByExpiration: The cluster expired and has been automatically locked. LockByRestoration: The cluster is scheduled to rollback and has been automatically locked. LockByDiskQuota: The cluster has used 90% of its storage and has been automatically locked.
EngineVersion	String	3.1.1.9	The version of the cluster engine.
EnableAirflow	Boolean	true	Indicates whether an Airflow cluster was created. Valid values: true: An Airflow cluster was created. false: No Airflow cluster was created.
ExecutorCount	String	1	The number of compute nodes that are used by the cluster in elastic mode.
StorageResource	String	8Core32GB	The specifications of storage resources in elastic mode. These resources are used to read and write data. You can increase the value of this parameter to improve the read and write performance of the cluster.
DBClusterId	String	am-bp***************	The ID of the cluster.
ConnectionString	String	am-bp**********************.ads.aliyuncs.com	The public endpoint of the cluster.
RdsInstanceId	String	rm-bp*************	The ID of the ApsaraDB RDS instance from which data is synchronized to the cluster. This parameter is returned only for MySQL analytic instances.
DBClusterType	String	Common	The type of the cluster or instance. Valid values: Common: common cluster RDS_ANALYSIS: MySQL analytic instance
CommodityCode	String	ads	The commodity code. ads is returned.
ExpireTime	String	2999-09-08T16:00:00Z	The time when the cluster expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Example: 2999-09-08T16:00:00Z. Note If the billing method of the cluster is set to subscription, the actual expiration time is returned. If the billing method of the cluster is set to pay-as-you-go, 2999-09-08T16:00:00Z is returned.
DBNodeStorage	Long	300	The storage capacity of the cluster. Unit: GB.
DBNodeClass	String	E8	The specifications of the node.
LockReason	String	instance_expired	The reason why the cluster is locked. Note This parameter is returned only when the cluster is locked. The value is instance_expire.
VPCId	String	vpc-bp******************	The ID of the virtual private cloud (VPC).
ComputeResource	String	8Core32GB	The specifications of computing resources in elastic mode. These resources are used to compute data. The increase of computing resources can speed up queries. You can adjust the value of this parameter to scale the cluster.
RegionId	String	cn-hangzhou	The region ID of the cluster.
ElasticIOResource	Integer	0	The elastic I/O unit (EIU). For more information, see EIUs. Note This parameter is returned only for clusters in elastic mode.
VSwitchId	String	vsw-bp******************	The ID of the vSwitch.
DBVersion	String	3.0	The version of the database engine. Only 3.0 is supported.
VPCCloudInstanceId	String	am-bp**************-controller	The ID of the instance that is deployed in the VPC.
DBClusterStatus	String	Running	The state of the cluster. For more information, see Cluster states.
ResourceGroupId	String	rg-ac*************	The ID of the resource group.
DBClusterNetworkType	String	vpc	The network type of the cluster. Only VPC is supported.
DBClusterDescription	String	adb_test	The description of the cluster.
UserENIStatus	Boolean	true	Indicates whether Elastic Network Interface (ENI) is enabled. Valid values: true false
ZoneId	String	cn-hangzhou-h	The zone ID of the cluster.
Category	String	MIXED_STORAGE	The edition of the cluster. Valid values: BASIC: reserved mode for Basic Edition CLUSTER: reserved mode for Cluster Edition MIXED_STORAGE: elastic mode for Cluster Edition Note For more information about cluster editions, see Editions.
Engine	String	AnalyticDB	The engine of the cluster. AnalyticDB is returned.
KmsId	String	sdfsdfdsf-sdfsdfsdf-sdfsdf-sdfsdf	The ID of the key that is used to encrypt disk data. Note This parameter is returned only when disk encryption is enabled on the AnalyticDB for MySQL cluster.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=DescribeDBClusterAttribute
&DBClusterId=am-bp***************
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterAttributeResponse>
    <RequestId>2895BB82-B2C1-408E-AA73-DB8D59******</RequestId>
    <Items>
        <DBCluster>
            <StorageResource>8Core32GB</StorageResource>
            <Category>MIXED_STORAGE</Category>
            <ResourceGroupId>rg-ac*************</ResourceGroupId>
            <Port>3306</Port>
            <DBClusterId>am-bp***************</DBClusterId>
            <DBClusterNetworkType>vpc</DBClusterNetworkType>
            <DBClusterType>Common</DBClusterType>
            <DiskType>cloud_essd</DiskType>
            <ElasticIOResource>0</ElasticIOResource>
            <DBVersion>3.0</DBVersion>
            <DtsJobId/>
            <DBNodeCount>1</DBNodeCount>
            <CommodityCode>ads</CommodityCode>
            <ExecutorCount>1</ExecutorCount>
            <LockReason/>
            <MaintainTime>04:00Z-05:00Z</MaintainTime>
            <Engine>AnalyticDB</Engine>
            <Tags>
                <Tag>
                    <Value>test1</Value>
                    <Key>tag1</Key>
                </Tag>
            </Tags>
            <DBNodeStorage>300</DBNodeStorage>
            <EngineVersion>3.1.4.6</EngineVersion>
            <UserENIStatus>true</UserENIStatus>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <VPCId>vpc-bp******************</VPCId>
            <DBClusterStatus>Running</DBClusterStatus>
            <VSwitchId>vsw-bp******************</VSwitchId>
            <Mode>flexible</Mode>
            <DBClusterDescription>adb_test</DBClusterDescription>
            <ComputeResource>8Core32GB</ComputeResource>
            <LockMode>Unlock</LockMode>
            <PayType>Postpaid</PayType>
            <DBNodeClass>E8</DBNodeClass>
            <EnableSpark>false</EnableSpark>
            <VPCCloudInstanceId>am-bp**************-controller</VPCCloudInstanceId>
            <CreationTime>2021-04-01T09:50:18Z</CreationTime>
            <RegionId>cn-hangzhou</RegionId>
            <ExpireTime>2999-09-08T16:00:00Z</ExpireTime>
            <ConnectionString>am-bp**********************.ads.aliyuncs.com</ConnectionString>
            <RdsInstanceId/>
        </DBCluster>
    </Items>
</DescribeDBClusterAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2895BB82-B2C1-408E-AA73-DB8D59******",
  "Items" : {
    "DBCluster" : [ {
      "StorageResource" : "8Core32GB",
      "Category" : "MIXED_STORAGE",
      "ResourceGroupId" : "rg-ac*************",
      "Port" : "3306",
      "DBClusterId" : "am-bp***************",
      "DBClusterNetworkType" : "vpc",
      "DBClusterType" : "Common",
      "DiskType" : "cloud_essd",
      "ElasticIOResource" : 0,
      "DBVersion" : "3.0",
      "DtsJobId" : "",
      "DBNodeCount" : 1,
      "CommodityCode" : "ads",
      "ExecutorCount" : 1,
      "LockReason" : "",
      "MaintainTime" : "04:00Z-05:00Z",
      "Engine" : "AnalyticDB",
      "Tags" : {
        "Tag" : [ {
          "Value" : "test1",
          "Key" : "tag1"
        } ]
      },
      "DBNodeStorage" : 300,
      "EngineVersion" : "3.1.4.6",
      "UserENIStatus" : true,
      "ZoneId" : "cn-hangzhou-h",
      "VPCId" : "vpc-bp******************",
      "DBClusterStatus" : "Running",
      "VSwitchId" : "vsw-bp******************",
      "Mode" : "flexible",
      "DBClusterDescription" : "adb_test",
      "ComputeResource" : "8Core32GB",
      "LockMode" : "Unlock",
      "PayType" : "Postpaid",
      "DBNodeClass" : "E8",
      "EnableSpark" : false,
      "VPCCloudInstanceId" : "am-bp**************-controller",
      "CreationTime" : "2021-04-01T09:50:18Z",
      "RegionId" : "cn-hangzhou",
      "ExpireTime" : "2999-09-08T16:00:00Z",
      "ConnectionString" : "am-bp**********************.ads.aliyuncs.com",
      "RdsInstanceId" : ""
    } ]
  }
}

Error codes


HttpCode	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The error message returned because the specified cluster ID does not exist. Check whether the cluster ID is valid.

For a list of error codes, visit the API Error Center.