All Products
Search
Document Center

AnalyticDB for MySQL:DescribeDBClusterAttribute

Last Updated:Apr 25, 2024

Queries the information about an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) 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:DescribeDBClusterAttributeRead
  • DBClusterLakeVersion
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Lakehouse 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.
amv-wz9509beptiz****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

A5C433C2-001F-58E3-99F5-3274C14DF8BD
Itemsobject []

The queried AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster information.

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.

2022-07-01T09:50:18Z
Expiredstring

Indicates whether the subscription cluster has expired. Valid values:

  • true
  • false
Note
  • If the cluster has expired, the system locks or releases the cluster within a period of time. We recommend that you renew the expired cluster. For more information, see Renewal policy.
  • This parameter is not returned for pay-as-you-go clusters.
  • false
    MaintainTimestring

    The maintenance window of the cluster. The time is displayed in the HH:mmZ-HH:mmZ format in UTC.

    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.
    Prepaid
    Tagsobject []

    The tags that are added to the cluster.

    Keystring

    The tag key.

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

    The tag value.

    test1
    Modestring

    The mode of the cluster. By default, flexible is returned, which indicates that the cluster is in elastic mode.

    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.
    ManualLock
    EngineVersionstring

    The minor version of the cluster.

    3.1.16
    StorageResourcestring

    The specifications of reserved storage resources. Each AnalyticDB compute unit (ACU) is equivalent to 1 core and 4 GB memory. 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.

    24ACU
    DBClusterIdstring

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

    amv-wz9509beptiz****
    ConnectionStringstring

    The public endpoint that is used to connect to the cluster.

    amv-wz9509beptiz****.ads.aliyuncs.com
    DBClusterTypestring

    The cluster type. By default, Common is returned, which indicates a common cluster.

    Common
    CommodityCodestring

    The billing method of the cluster. Valid values:

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

    The expiration time of the cluster.

    • 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, null is returned.
    2022-10-01T09:50:18Z
    LockReasonstring

    The reason why the cluster is locked.

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

    The virtual private cloud (VPC) ID of the cluster.

    vpc-bp13h7uzhulpu****
    ComputeResourcestring

    The specifications of reserved computing resources. Each ACU is equivalent to 1 core and 4 GB memory. 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.

    16ACU
    RegionIdstring

    The region ID of the cluster.

    cn-hangzhou
    VSwitchIdstring

    The vSwitch ID of the cluster.

    vsw-uf629gydd54ld****
    DBVersionstring

    The engine version of the AnalyticDB for MySQL Data Lakehouse Edition cluster. 5.0 is returned.

    5.0
    DBClusterStatusstring

    The state of the cluster. Valid values:

    • Preparing
    • Creating
    • Running
    • Deleting
    • Restoring
    • ClassChanging
    • NetAddressCreating
    • NetAddressDeleting
    • NetAddressModifying
    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
    false
    ZoneIdstring

    The zone ID of the cluster.

    cn-hangzhou-h
    Enginestring

    The engine of the cluster. AnalyticDB is returned.

    AnalyticDB
    ReservedACUstring

    The remaining reserved computing resources that are available in the cluster. Each ACU is equivalent to 1 core and 4 GB memory.

    24ACU
    ComputeResourceTotalstring

    The total amount of computing resources in the cluster. Each ACU is equivalent to 1 core and 4 GB memory.

    48ACU
    StorageResourceTotalstring

    The total amount of storage resources in the cluster. Each ACU is equivalent to 1 core and 4 GB memory.

    24ACU
    SupportedFeaturesobject

    A reserved parameter.

    string

    A reserved parameter.

    N/A

    Examples

    Sample success responses

    JSONformat

    {
      "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": "N/A\n"
            }
          }
        ]
      }
    }

    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
    2023-09-26The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
    Output ParametersThe response structure of the API has changed.
    2023-07-27The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
    Output ParametersThe response structure of the API has changed.
    2022-09-27The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
    Output ParametersThe response structure of the API has changed.