All Products
Search
Document Center

AnalyticDB:DescribeDBClusterAttribute

Last Updated:Aug 30, 2024

Queries the information about an AnalyticDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeDBClusterAttributeget
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
am-bp111m2cfrdl1****
RegionIdstringNo

The region ID of the cluster.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

2895BB82-B2C1-408E-AA73-DB8D59******
Itemsarray<object>

The queried cluster information.

object

The information about the cluster.

CreationTimestring

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.

2021-04-01T09:50:18Z
EnableSparkboolean

Indicates whether a Spark cluster was created. Valid values:

  • true
  • false
false
DtsJobIdstring

The ID of the Data Transmission Service (DTS) synchronization job. This parameter is returned only for MySQL analytic instances.

dtsb1hp3790****
DBNodeCountlong

The number of node groups.

1
Expiredstring

Indicates whether the cluster has expired. Valid values:

  • true
  • false
false
MaintainTimestring

The maintenance window of the cluster. The time is displayed in the HH:mmZ-HH:mmZ format in UTC. Example: 04:00Z-05:00Z, which indicates that routine maintenance is performed from 04:00 to 05:00.

Note For more information about maintenance windows, see Configure a maintenance window.
04:00Z-05:00Z
PayTypestring

The billing method of the cluster. Valid values:

  • Postpaid: pay-as-you-go.
  • Prepaid: subscription.
Postpaid
DiskTypestring

The disk type of the cluster. Valid values:

  • local_ssd: local disk.
  • cloud: basic disk.
  • cloud_ssd: standard SSD.
  • cloud_efficiency: ultra disk.
  • cloud_essd0: PL0 Enterprise SSD (ESSD).
  • cloud_essd: PL1 ESSD.
  • cloud_essd2: PL2 ESSD.
  • cloud_essd3: PL3 ESSD.
Note For more information about ESSDs, see ESSDs .
cloud_essd
Tagsarray<object>

The tags that are added to the cluster.

object

The tag that is added to the cluster.

Keystring

The tag key.

Note You can call the TagResources operation to add a tag to the cluster.
tag1
Valuestring

The tag value.

test1
Modestring

The mode of the cluster. Valid values:

  • flexible: elastic mode.
  • reserver: reserved mode.
Note For more information about cluster modes, see Editions .
flexible
Portinteger

The port number that is used to connect to the cluster.

3306
LockModestring

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 cluster expiration.
  • LockByRestoration: The cluster is automatically locked due to cluster restoration.
  • LockByDiskQuota: The cluster is automatically locked when 90% of the cluster storage is used.
Unlock
EngineVersionstring

The minor version of the cluster.

3.1.1.9
EnableAirflowboolean

Indicates whether an Airflow cluster was created. Valid values:

  • true
  • false
true
ExecutorCountstring

The number of compute nodes that are used by the cluster in elastic mode.

1
StorageResourcestring

The specifications of storage resources that are used in the cluster in elastic mode. Storage resources are used to read and write data. The increase in the storage resources can improve the read and write performance of the cluster.

8Core32GB
DBClusterIdstring

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

am-bp111m2cfrdl1****
ConnectionStringstring

The Virtual Private Cloud (VPC) endpoint that is used to connect to the cluster.

am-bp111m2cfrdl1****.ads.aliyuncs.com
RdsInstanceIdstring

The ID of the ApsaraDB RDS instance from which data is synchronized to the cluster. This parameter is returned only for MySQL analytic instances.

rm-bp837jsdp2****
DBClusterTypestring

The type of the cluster. Valid values:

  • Common: common cluster.
  • RDS_ANALYSIS: MySQL analytic instance.
Common
CommodityCodestring

The billing method of the cluster. Valid values:

  • ads: pay-as-you-go.
  • ads_pre: subscription.
ads
ExpireTimestring

The expiration time of the cluster. 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 subscription, the actual expiration time is returned.

  • If the billing method of the cluster is pay-as-you-go, 2999-09-08T16:00:00Z is returned.

2999-09-08T16:00:00Z
DBNodeStoragelong

The storage capacity of the cluster. Unit: GB.

300
DBNodeClassstring

The instance type of the cluster.

E8
LockReasonstring

The reason why the cluster is locked.

Note This parameter is returned only when the cluster was locked. instance_expire is returned.
instance_expired
VPCIdstring

The VPC ID of the cluster.

vpc-bp13h7uzhulpuxvnp****
ComputeResourcestring

The specifications of computing resources that are used in the cluster in elastic mode. Computing resources are used to compute data. The increase in the computing resources can accelerate queries. You can scale computing resources based on your business requirements.

8Core32GB
RegionIdstring

The region ID of the cluster.

cn-hangzhou
ElasticIOResourceinteger

The number of elastic I/O units (EIUs).

2
VSwitchIdstring

The vSwitch ID of the cluster.

vsw-bp1syh8vvw8yech7n****
DBVersionstring

The engine version of the cluster. 3.0 is returned.

3.0
VPCCloudInstanceIdstring

The ID of the cluster that resides in the VPC.

am-bp111m2cfrdl1****-controller
DBClusterStatusstring

The status of the cluster. For more information, see Cluster states.

Running
ResourceGroupIdstring

The resource group ID.

rg-acfmyiu4ekp****
DBClusterNetworkTypestring

The network type of the cluster. VPC is returned.

vpc
DBClusterDescriptionstring

The description of the cluster.

adb_test
UserENIStatusboolean

Indicates whether Elastic Network Interface (ENI) is enabled. Valid values:

  • true
  • false
true
ZoneIdstring

The zone ID of the cluster.

cn-hangzhou-h
Categorystring

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 .
MIXED_STORAGE
Enginestring

The database engine of the cluster. AnalyticDB is returned.

AnalyticDB
KmsIdstring

The ID of the key that is used to encrypt disk data.

Note This parameter is returned only when disk encryption is enabled.
e1935511-cf88-1123-a0f8-1be8d251****
InnerIpstring

The public IP address of the cluster.

10.1.XX.XX
InnerPortstring

The public port number.

3306
DiskPerformanceLevelstring

The ESSD performance level.

PL1
ElasticIOResourceSizestring

The single-node specifications of an EIU. Valid values:

  • 8Core64GB: If this value is returned, the specifications of an EIU are 24 cores and 192 GB memory.
  • 12Core96GB: If this value is returned, the specifications of an EIU are 36 cores and 288 GB memory.
8Core64GB
DiskEncryptionstring

Indicates whether disk encryption is enabled. Valid values:

  • true
  • false
false
TaskInfoobject

The job information.

Namestring

The name of the job.

analyticDBFlexibleScaleOut
Statusstring

The status of the job. Valid values:

  • NOT_RUN
  • RUNNING
  • SUCCEED
RUNNING
Progressstring

The progress of the job. Unit: %.

10
StepListarray<object>

The job steps.

object
StepNamestring

The name of the job step.

ApplyResource
StepDescstring

The description of the job step.

Apply resource
StepStatusstring

The status of the job step. Valid values:

  • NOT_RUN
  • RUNNING
  • SUCCEED
SUCCEED
StepProgressstring

The progress of the job step. Unit: %.

50
StartTimestring

The start time of the job step. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2024-03-10T09:28:34Z
EndTimestring

The end time of the job step. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.

2024-03-10T10:28:34Z
ProductVersionstring

The edition of the cluster. Valid values:

  • BasicVersion: Basic Edition.
  • EnterpriseVersion: Enterprise Edition.
BasicVersion

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-05-28The Error code has changed. The response structure of the API has changedView Change Details
2024-05-17The Error code has changed. The request parameters of the API has changedView Change Details
2024-04-01The Error code has changed. The response structure of the API has changedView Change Details
2024-03-05The Error code has changed. The response structure of the API has changedView Change Details
2023-12-01The Error code has changed. The response structure of the API has changedView Change Details
2022-11-30API Description Update. The Error code has changed. The response structure of the API has changedView Change Details