All Products
Search

This Product

    AnalyticDB:DescribeDBClusters

    Document Center

    AnalyticDB:DescribeDBClusters

    Last Updated:Jun 11, 2026

    Mengkueri kluster Data Lakehouse Edition di region yang ditentukan.

    Deskripsi operasi

    Untuk daftar endpoint layanan saat ini, lihat Service Endpoints.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    adb:DescribeDBClusters

    list

    *DBClusterLakeVersion

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID region.

    Catatan

    Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID region yang tersedia.

    cn-hangzhou
    DBClusterIds

    string

    No

    ID kluster.

    Jika Anda tidak menentukan parameter ini, operasi akan mengembalikan informasi tentang semua kluster di region yang ditentukan.

    amv-bp1r053byu48p****
    DBClusterDescription

    string

    No

    Deskripsi kluster.

    • Deskripsi tidak boleh dimulai dengan http:// atau https://.

    • Panjang deskripsi harus 2 hingga 256 karakter.

    test
    DBClusterStatus

    string

    No

    Status kluster. Nilai yang valid:

    • Preparing: Kluster sedang dipersiapkan.

    • Creating: Kluster sedang dibuat.

    • Running: Kluster sedang berjalan.

    • Deleting: Kluster sedang dihapus.

    • Restoring: Kluster sedang dipulihkan dari cadangan.

    • ClassChanging: Spesifikasi kluster sedang diubah.

    • NetAddressCreating: Koneksi jaringan sedang dibuat untuk kluster.

    • NetAddressDeleting: Koneksi jaringan kluster sedang dihapus.

    • NetAddressModifying: Koneksi jaringan kluster sedang dimodifikasi.

    Running
    PageSize

    integer

    No

    Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid:

    • 30 (default)

    • 50

    • 100

    30
    PageNumber

    integer

    No

    Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.

    1
    ResourceGroupId

    string

    No

    ID grup sumber daya. Jika Anda tidak menentukan parameter ini, operasi akan mengembalikan informasi tentang kluster di semua grup sumber daya.

    rg-4690g37929****
    Tag

    array<object>

    No

    Tag yang digunakan untuk memfilter kluster.

    object

    No

    Tag kluster.

    Key

    string

    No

    Kunci tag.

    tag1
    Value

    string

    No

    Nilai tag.

    test1
    ProductVersion

    string

    No

    Versi produk. Nilai yang valid:

    • EnterpriseVersion: Enterprise Edition.

    • BasicVersion: Basic Edition.

    Catatan

    Jika Anda tidak menentukan parameter ini, operasi akan mengembalikan kluster dari semua versi produk.

    BasicVersion
    DBClusterVersion

    string

    No

    Versi kluster. Nilai yang valid:

    • 3.0: Data Warehouse Edition.

    • 5.0 (default): Mencakup Data Lakehouse Edition, Enterprise Edition, dan Basic Edition.

    • All: Semua edisi, termasuk Data Warehouse, Data Lakehouse, Enterprise, dan Basic edition.

    5.0

    Elemen respons

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    Jumlah total entri yang dikembalikan.

    1
    PageSize

    integer

    Jumlah entri per halaman.

    30
    RequestId

    string

    ID permintaan.

    A5EDBA27-AF3E-5966-9503-FD1557E19167
    PageNumber

    integer

    Nomor halaman.

    1
    Items

    object

    DBCluster

    array<object>

    Detail kluster.

    array<object>

    Detail kluster.

    Expired

    string

    Indicates whether a subscription cluster has expired. Valid values:

    • true: Expired.

    • false: Not expired.

    Catatan

    • If a cluster expires, it may be locked or released after a grace period. We recommend that you renew your subscription. For more information, see Renewal policy.

    • This parameter is not returned for pay-as-you-go clusters.

    false
    CreateTime

    string

    Time when the cluster was created, in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.

    2022-04-01T09:50:18Z
    PayType

    string

    Payment type. Valid values:

    • Postpaid: Pay-as-you-go.

    • Prepaid: Subscription.

    Prepaid
    Mode

    string

    Cluster mode. Default value: flexible, which indicates an elastic-mode cluster.

    flexible
    Port

    string

    Cluster port number.

    3306
    LockMode

    string

    Cluster lock status. Valid values:

    • Unlock: Unlocked.

    • ManualLock: Manually locked.

    • LockByExpiration: Locked due to expiration.

    Unlock
    StorageResource

    string

    Reserved storage resource specification. One ACU equals approximately one vCPU and 4 GB of memory. Storage resources are used for data read and write operations. Increasing this resource improves cluster read and write performance.

    24ACU
    DBClusterId

    string

    Data Lakehouse Edition cluster ID.

    amv-bp163885f8q21****
    ConnectionString

    string

    Public endpoint of the cluster.

    amv-bp163885f8q21****.ads.aliyuncs.com
    DBClusterType

    string

    Cluster type. Default value: Common, which indicates a standard cluster.

    Common
    CommodityCode

    string

    Commodity payment type. Valid values:

    • ads: Pay-as-you-go commodity.

    • ads_pre: Subscription commodity.

    ads_pre
    ExpireTime

    string

    Time when the cluster expires, in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.

    Catatan

    • This parameter returns the actual expiration time if the cluster uses the subscription billing method.

    • This parameter returns an empty string if the cluster uses the pay-as-you-go billing method.

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

    string

    Reason why the cluster is locked.

    Catatan

    This parameter is returned only when the cluster is locked. Its value is always instance_expire.

    instance_expired
    VPCId

    string

    Virtual private cloud (VPC) ID.

    vpc-bp13h7uzhulpuxvnp****
    RegionId

    string

    Region ID where the cluster resides.

    cn-hangzhou
    ComputeResource

    string

    Reserved compute resource specification. One ACU equals approximately one vCPU and 4 GB of memory. Compute resources are used for data processing. Increasing compute resources speeds up queries. You can scale these resources up or down based on your cluster's performance needs.

    16ACU
    VSwitchId

    string

    vSwitch ID.

    vsw-bp1syh8vvw8yech7n****
    DBVersion

    string

    Database version. Only version 5.0 is supported.

    5.0
    DBClusterStatus

    string

    Cluster status. Valid values:

    • Preparing: Preparing.

    • Creating: Creating.

    • Running: Running.

    • Deleting: Deleting.

    • Restoring: Restoring backup.

    • ClassChanging: Upgrading or downgrading.

    • NetAddressCreating: Creating network address.

    • NetAddressDeleting: Deleting network address.

    • NetAddressModifying: Modifying network address.

    Running
    ResourceGroupId

    string

    Resource group ID.

    rg-acfmyiu4ekp****
    DBClusterNetworkType

    string

    Cluster network type. Only VPC is supported.

    VPC
    DBClusterDescription

    string

    Cluster description.

    adb_test
    ZoneId

    string

    Zone ID where the cluster resides.

    cn-hangzhou-h
    Engine

    string

    Cluster engine. Fixed value: AnalyticDB.

    AnalyticDB
    ReservedACU

    string

    Remaining reserved compute resources available for allocation. One ACU equals approximately one vCPU and 4 GB of memory.

    32ACU
    Tags

    object

    Tag

    array<object>

    Tag list.

    object

    Tag list.

    Key

    string

    Tag key.

    Catatan

    Call the TagResources operation to create tags for the target cluster.

    tag1
    Value

    string

    Tag value.

    test1
    Category

    string

    Product series. This parameter is meaningful only for Data Warehouse Edition instances. Valid values:

    • BASIC: Reserved-mode Basic Edition.

    • CLUSTER: Reserved-mode Cluster Edition.

    • MIXED_STORAGE: Elastic-mode Cluster Edition (new).

    Catatan

    For more information about product series, see product series.

    MIXED_STORAGE
    InnerPort

    string

    Internal network port of the cluster.

    3306
    VPCCloudInstanceId

    string

    Internal endpoint.

    am-bp163885f8q21****-controller
    InnerIp

    string

    Internal IP address of the cluster.

    10.1.xx.xx
    DtsJobId

    string

    DTS sync task ID. This parameter is returned only for MySQL analytic instances.

    dtsb1578j90XXXX
    ElasticIOResource

    integer

    Elastic IO Unit (EIU). For more information, see EIU details.

    Catatan

    This parameter is returned only for elastic-mode clusters.

    2
    RdsInstanceId

    string

    Source RDS instance ID for synchronization. This parameter is returned only for MySQL analytic instances.

    rm-bp11q28kvl688****
    ExecutorCount

    string

    Number of compute nodes used by the cluster in elastic mode.

    1
    DBNodeClass

    string

    Node specifications. This parameter is meaningful only for Data Warehouse Edition instances.

    E8
    DiskType

    string

    Disk type. Valid values:

    • local_ssd: Local SSD.

    • cloud: Basic disk.

    • cloud_ssd: Standard SSD.

    • cloud_efficiency: Ultra disk.

    • cloud_essd: ESSD disk (PL1 level).

    • cloud_essd2: ESSD disk (PL2 level).

    • cloud_essd3: ESSD disk (PL3 level).

    Catatan

    For more information about ESSD disks, see ESSD disk specifications.

    cloud_essd
    DBNodeStorage

    integer

    Storage capacity of the cluster, in GB.

    300
    DBNodeCount

    integer

    Number of node groups.

    2
    TaskInfo

    object

    Task progress information.

    Name

    string

    Task name.

    analyticDBFlexibleScaleOut
    Status

    string

    Task status. Valid values:

    • NOT_RUN: Waiting to run.

    • RUNNING: Running.

    • SUCCEED: Completed.

    RUNNING
    Progress

    string

    Task progress, in percent (%).

    10%
    StepList

    object

    StepList

    array<object>

    Task steps.

    object

    Task step.

    StepName

    string

    Step name.

    ApplyResource
    StepDesc

    string

    Step description.

    Apply resource
    StepStatus

    string

    Step status. Valid values:

    • NOT_RUN: Waiting to run.

    • RUNNING: Running.

    • SUCCEED: Completed.

    SUCCEED
    StepProgress

    string

    Step progress, in percent (%).

    50%
    StartTime

    string

    Start time of the step. Format: YYYY-MM-DDTHH:mm:ssZ.

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

    string

    End time of the step. Format: YYYY-MM-DDTHH:mm:ssZ.

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

    string

    Product form. Valid values:

    • LegacyForm: Traditional form.

    • IntegrationForm: Integrated form.

    IntegrationForm
    ProductVersion

    string

    Product version. Valid values:

    • BasicVersion: Basic Edition.

    • EnterpriseVersion: Enterprise Edition.

    EnterpriseVersion
    ReservedNodeSize

    string

    Specification of each reserved resource node.

    8ACU
    ReservedNodeCount

    integer

    Number of reserved resource nodes.

    1
    AINodeSpec

    string

    ADB.MLGrand.5
    AINodeNumber

    integer

    1

    Contoh

    Respons sukses

    JSONformat

    {
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "Expired": "false",
        "CreateTime": "2022-04-01T09:50:18Z",
        "PayType": "Prepaid",
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "24ACU",
        "DBClusterId": "amv-bp163885f8q21****",
        "ConnectionString": "amv-bp163885f8q21****.ads.aliyuncs.com",
        "DBClusterType": "Common",
        "CommodityCode": "ads_pre",
        "ExpireTime": "2022-07-01T09:50:18Z",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnp****",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "16ACU",
        "VSwitchId": "vsw-bp1syh8vvw8yech7n****",
        "DBVersion": "5.0",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "VPC",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Engine": "AnalyticDB",
        "ReservedACU": "32ACU",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Category": "MIXED_STORAGE",
        "InnerPort": "3306",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "InnerIp": "10.1.xx.xx",
        "DtsJobId": "dtsb1578j90XXXX",
        "ElasticIOResource": 2,
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "ExecutorCount": "1",
        "DBNodeClass": "E8",
        "DiskType": "cloud_essd",
        "DBNodeStorage": 300,
        "DBNodeCount": 2,
        "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"
              }
            ]
          }
        },
        "ProductForm": "IntegrationForm",
        "ProductVersion": "EnterpriseVersion",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 1,
        "AINodeSpec": "ADB.MLGrand.5",
        "AINodeNumber": 1
      }
    ]
  }
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    500 InternalError An error occurred while processing your request.
    503 ServiceUnavailable An error occurred while processing your request.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.