Gunakan DescribeDBClusters untuk mengkueri kluster AnalyticDB untuk MySQL - AnalyticDB - Alibaba Cloud - AnalyticDB

Menampilkan daftar kluster Edisi Danau Data Terpadu.

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

get

DBCluster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Catatan Anda dapat memanggil operasi DescribeRegions untuk Tampilan ID wilayah yang tersedia.	cn-hangzhou
DBClusterIds	string	No	ID kluster. Catatan Anda dapat menentukan ID kluster apa pun di wilayah yang ditentukan.	am-bp1r053byu48p****
DBClusterDescription	string	No	Deskripsi kluster. Tidak dapat diawali dengan `http://` atau `https://`. Panjangnya harus 2 hingga 256 karakter.	test
DBClusterStatus	string	No	Status kluster. Nilai valid: Preparing: Menyiapkan. Creating: Membuat. Restoring: Memulihkan dari cadangan. Running: Berjalan. Deleting: Menghapus. ClassChanging: Meningkatkan atau mati spesifikasi. NetAddressCreating: Membuat titik akhir jaringan. NetAddressDeleting: Menghapus titik akhir jaringan.	Running
PageSize	integer	No	Jumlah entri per halaman. Nilai valid: 30 (nilai default) 50 100.	30
PageNumber	integer	No	Nomor halaman. Nilai valid adalah bilangan bulat yang lebih besar dari 0 dan kurang dari atau sama dengan nilai maksimum tipe data integer. Nilai default: 1.	1
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-4690g37929XXXX
Tag	array<object>	No	Daftar tag.
	object	No	Details about the items in the list.
Key	string	No	The tag key. You can filter clusters by tag keys. You can specify up to 20 key-value pairs. The numbers n in `Tag.N.Key` and `Tag.N.Value` must be unique and consecutive integers starting from 1. Catatan A tag key can be up to 64 characters in length. It cannot start with `aliyun`, `acs:`, `http://`, or `https://`.	tag1
Value	string	No	The tag value. You can filter clusters by tag values. You can specify up to 20 key-value pairs. The numbers n in `Tag.N.Key` and `Tag.N.Value` must be unique and consecutive integers starting from 1. Catatan A tag value can be up to 64 characters in length. It cannot start with `aliyun`, `acs:`, `http://`, or `https://`.	test1
DBVersion	string	No	Versi database. Nilai valid: 3.0.	3.0
DBClusterVersion	string	No	Versi kluster. Nilai valid: 3.0: Edisi Gudang Data. 5.0 (nilai default): Edisi Danau Data Terpadu, Edisi Perusahaan, dan Edisi Dasar. All: Semua versi, termasuk Edisi Gudang Data, Edisi Danau Data Terpadu, Edisi Perusahaan, dan Edisi Dasar.	3.0

Elemen respons

Element	Type	Description	Example
	object	Details about the returned list.
TotalCount	integer	The total number of entries.	1
PageSize	integer	The number of entries returned on each page.	30
RequestId	string	The request ID.	D65A809F-34CE-4550-9BC1-0ED21ETG380
PageNumber	integer	The page number.	1
Items	object
DBCluster	array<object>	The list of clusters.
	array<object>	Details about the cluster list.
DtsJobId	string	The DTS synchronization task ID. This parameter is returned only for MySQL analytic instances.	dtsb1578j90XXXX
DBNodeCount	integer	The number of node groups.	1
Expired	string	Indicates whether the cluster has expired. Valid values: true: Expired. false: Not expired.	false
CreateTime	string	The time when the cluster was created. The time is in UTC and follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2021-04-01T09:50:18Z.	2021-04-01T09:50:18Z
PayType	string	The billing method. Valid values: Postpaid: Pay-as-you-go. Prepaid: Subscription.	Postpaid
DiskType	string	The disk type. Valid values: local_ssd: Local SSD. cloud: Basic disk. cloud_ssd: Standard SSD. cloud_efficiency: Ultra disk. cloud_essd0: ESSD PL0. cloud_essd: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. Catatan For more information about ESSDs, see ESSD specifications.	cloud_essd
Tags	object
Tag	array<object>	The list of tags.
	object	Details about the tag list.
Key	string	The tag key. Catatan You can call the TagResources operation to add tags to a cluster.	tag1
Value	string	The tag value.	test1
Mode	string	The cluster mode. Valid values: flexible: Flexible mode. reserver: Reserved mode. Catatan For more information about cluster modes, see Product editions.	flexible
Port	string	The port number. Default value: 3306.	3306
LockMode	string	The lock mode. Valid values: Unlock: Unlocked. ManualLock: Manually locked. LockByExpiration: Automatically locked after expiration. LockByRestoration: Automatically locked before rollback. LockByDiskQuota: Automatically locked when storage usage reaches 90% of the quota.	Unlock
StorageResource	string	The storage resource specification used in flexible mode. This resource is used for data read and write operations. Increasing this resource improves cluster read and write performance.	8Core32GB
ExecutorCount	string	The number of compute nodes used by the cluster in flexible mode.	1
DBClusterId	string	The cluster ID.	am-bp163885f8q21****
ConnectionString	string	The public endpoint of the cluster.	am-bp163885f8q21****.ads.aliyuncs.com
RdsInstanceId	string	The source ApsaraDB RDS instance ID. This parameter is returned only for MySQL analytic instances.	rm-bp11q28kvl688****
DBClusterType	string	The cluster type. Valid values: Common: Standard cluster. RDS_ANALYSIS: MySQL analytic instance.	Common
CommodityCode	string	The commodity code. Set this parameter to ads.	ads
ExpireTime	string	The time when the cluster expires. The time is in UTC and follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2999-09-08T16:00:00Z. Catatan If the cluster uses the subscription billing method, this parameter returns the actual expiration time. If the cluster uses the pay-as-you-go billing method, this parameter returns the fixed value 2999-09-08T16:00:00Z.	2999-09-08T16:00:00Z
DBNodeStorage	integer	The storage capacity of the cluster. Unit: GB.	300
DBNodeClass	string	The node specifications.	E8
LockReason	string	The 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	The ID of the virtual private cloud (VPC).	vpc-bp13h7uzhulpuxvnpXXXX
RegionId	string	The region ID where the cluster resides.	cn-hangzhou
ComputeResource	string	The compute resource specification used in flexible mode. This resource is used for data computation. Increasing compute resources speeds up queries. You can scale these resources up or down based on your cluster's performance needs.	8Core32GB
ElasticIOResource	integer	The Elastic IO Unit (EIU). For more information, see EIU overview. Catatan This parameter is returned only for clusters in flexible mode.	0
VSwitchId	string	The ID of the vSwitch.	vsw-bp1syh8vvw8yech7nXXXX
DBVersion	string	The database version. Only version 3.0 is supported.	3.0
VPCCloudInstanceId	string	The VPC instance ID.	am-bp163885f8q21****-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 cluster description.	adb_test
ZoneId	string	The zone ID where the cluster resides.	cn-hangzhou-h
Category	string	The product edition. Valid values: BASIC: Basic Edition in reserved mode. CLUSTER: Cluster Edition in reserved mode. MIXED_STORAGE: Cluster Edition in flexible mode (new). Catatan For more information about product editions, see Product editions.	MIXED_STORAGE
Engine	string	The cluster engine. Set this parameter to AnalyticDB.	AnalyticDB
InnerIp	string	The public IP address.	10.1.xx.xx
InnerPort	string	The port number.	3306
TaskInfo	object	Task progress information.
Name	string	The task name.	analyticDBFlexibleScaleOut
Status	string	The task status. Valid values: NOT_RUN: Waiting to run. RUNNING: Running. SUCCEED: Completed.	RUNNING
Progress	string	The task progress. Unit: %.	10
StepList	object
StepList	array<object>	The task steps.
	object	The task step.
StepName	string	The step name.	ApplyResource
StepDesc	string	The step description.	Apply resource
StepStatus	string	The step status. Valid values: NOT_RUN: Waiting to run. RUNNING: Running. SUCCEED: Completed.	SUCCEED
StepProgress	string	The step progress. Unit: %.	50
StartTime	string	The time when the step started. Format: YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	The time when the step ended. Format: YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
ProductVersion	string	The product version. Valid values: BasicVersion: Basic Edition. EnterpriseVersion: Enterprise Edition.	EnterpriseVersion

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 30,
  "RequestId": "D65A809F-34CE-4550-9BC1-0ED21ETG380",
  "PageNumber": 1,
  "Items": {
    "DBCluster": [
      {
        "DtsJobId": "dtsb1578j90XXXX",
        "DBNodeCount": 1,
        "Expired": "false",
        "CreateTime": "2021-04-01T09:50:18Z",
        "PayType": "Postpaid",
        "DiskType": "cloud_essd",
        "Tags": {
          "Tag": [
            {
              "Key": "tag1",
              "Value": "test1"
            }
          ]
        },
        "Mode": "flexible",
        "Port": "3306",
        "LockMode": "Unlock",
        "StorageResource": "8Core32GB",
        "ExecutorCount": "1",
        "DBClusterId": "am-bp163885f8q21****",
        "ConnectionString": "am-bp163885f8q21****.ads.aliyuncs.com",
        "RdsInstanceId": "rm-bp11q28kvl688****",
        "DBClusterType": "Common",
        "CommodityCode": "ads",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "DBNodeStorage": 300,
        "DBNodeClass": "E8",
        "LockReason": "instance_expired",
        "VPCId": "vpc-bp13h7uzhulpuxvnpXXXX",
        "RegionId": "cn-hangzhou",
        "ComputeResource": "8Core32GB",
        "ElasticIOResource": 0,
        "VSwitchId": "vsw-bp1syh8vvw8yech7nXXXX",
        "DBVersion": "3.0",
        "VPCCloudInstanceId": "am-bp163885f8q21****-controller",
        "DBClusterStatus": "Running",
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "DBClusterNetworkType": "vpc",
        "DBClusterDescription": "adb_test",
        "ZoneId": "cn-hangzhou-h",
        "Category": "MIXED_STORAGE",
        "Engine": "AnalyticDB",
        "InnerIp": "10.1.xx.xx",
        "InnerPort": "3306",
        "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": "EnterpriseVersion"
      }
    ]
  }
}

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.