Gunakan DescribeDBClusterAttribute untuk melihat atribut kluster - AnalyticDB

Anda dapat memanggil operasi DescribeDBClusterAttribute untuk melihat detail kluster AnalyticDB for MySQL tertentu.

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:DescribeDBClusterAttribute

get

DBCluster

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster AnalyticDB for MySQL Data Warehouse Edition (V3.0). Catatan Panggil operasi DescribeDBClusters untuk menanyakan ID semua kluster AnalyticDB for MySQL Data Warehouse Edition (V3.0) di wilayah tertentu.	am-bp111m2cfrdl1****
RegionId	string	No	ID wilayah kluster.	cn-hangzhou

Elemen respons

Element	Type	Description	Example
	object	Detail respons.
RequestId	string	ID permintaan.	2895BB82-B2C1-408E-AA73-DB8D59******
Items	object
DBCluster	array<object>	Daftar informasi kluster.
	array<object>	Detail kluster.
CreationTime	string	Waktu pembuatan kluster. Format waktunya adalah yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2021-04-01T09:50:18Z
EnableSpark	boolean	Menunjukkan apakah kluster Spark dibuat. Nilai yang valid: true: Kluster Spark dibuat. false: Tidak ada kluster Spark yang dibuat.	false
DtsJobId	string	ID tugas sinkronisasi DTS. Parameter ini hanya dikembalikan untuk instansi analitik MySQL.	dtsb1hp3790****
DBNodeCount	integer	Jumlah grup node.	1
Expired	string	Menunjukkan apakah kluster telah kedaluwarsa. Nilai yang valid: true: Kluster telah kedaluwarsa. false: Kluster belum kedaluwarsa.	false
MaintainTime	string	Jendela pemeliharaan kluster. Format waktunya adalah HH:mmZ-HH:mmZ. Contohnya, 04:00Z-05:00Z berarti jendela pemeliharaan berlangsung dari pukul 04.00 hingga 05.00. Catatan Untuk informasi selengkapnya tentang jendela pemeliharaan, lihat Setel jendela pemeliharaan.	04:00Z-05:00Z
PayType	string	Metode penagihan kluster. Nilai yang valid: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
DiskType	string	Tipe disk kluster. Nilai yang valid: local_ssd: SSD lokal. cloud: disk dasar. cloud_ssd: SSD standar. cloud_efficiency: disk ultra. cloud_essd0: ESSD PL0. cloud_essd: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. Catatan Untuk informasi selengkapnya tentang ESSD, lihat ESSDs.	cloud_essd
Tags	object
Tag	array<object>	Daftar informasi tag.
	object	Detail tag.
Key	string	Kunci tag. Catatan Panggil operasi TagResources untuk membuat tag untuk kluster.	tag1
Value	string	Nilai tag.	test1
Mode	string	Mode kluster. Nilai yang valid: flexible: Mode fleksibel. reserver: Mode reservasi. Catatan Untuk informasi selengkapnya tentang mode kluster, lihat Edisi.	flexible
Port	integer	Nomor port kluster.	3306
LockMode	string	Mode kunci kluster. Nilai yang valid: Unlock: Kluster tidak terkunci. ManualLock: Kluster dikunci secara manual. LockByExpiration: Kluster dikunci otomatis setelah kedaluwarsa. LockByRestoration: Kluster dikunci otomatis sebelum rollback. LockByDiskQuota: Kluster dikunci otomatis setelah ruang penyimpanan penuh. Penggunaan penyimpanan data telah mencapai 90% dari total penyimpanan.	Unlock
EngineVersion	string	Versi mesin database kluster.	3.1.1.9
EnableAirflow	boolean	Menunjukkan apakah kluster Airflow dibuat. Nilai yang valid: true: Kluster Airflow dibuat. false: Tidak ada kluster Airflow yang dibuat.	true
ExecutorCount	string	Jumlah node komputasi yang digunakan dalam kluster ber-mode fleksibel.	1
StorageResource	string	Spesifikasi sumber daya penyimpanan yang digunakan dalam kluster ber-mode fleksibel. Sumber daya ini digunakan untuk membaca dan menulis data. Anda dapat menambahkan sumber daya penyimpanan untuk meningkatkan kinerja baca-tulis kluster.	8Core32GB
DBClusterId	string	ID kluster AnalyticDB for MySQL Data Warehouse Edition (V3.0).	am-bp111m2cfrdl1****
ConnectionString	string	Titik akhir VPC kluster.	am-bp111m2cfrdl1****.ads.aliyuncs.com
RdsInstanceId	string	ID instans RDS sumber. Parameter ini hanya dikembalikan untuk instansi analitik MySQL.	rm-bp837jsdp2****
DBClusterType	string	Jenis kluster. Nilai yang valid: Common: kluster reguler. RDS_ANALYSIS: instansi analitik untuk MySQL.	Common
CommodityCode	string	Metode penagihan produk. Nilai yang valid: ads: pay-as-you-go ads_pre: subscription	ads
ExpireTime	string	Waktu kedaluwarsa kluster. Format waktunya adalah yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC. Contohnya: 2999-09-08T16:00:00Z. Catatan Jika kluster merupakan kluster langganan, waktu kedaluwarsa aktual akan dikembalikan. Jika kluster merupakan kluster bayar sesuai pemakaian, nilai tetap 2999-09-08T16:00:00Z akan dikembalikan.	2999-09-08T16:00:00Z
DBNodeStorage	integer	Kapasitas penyimpanan kluster. Satuan: GB.	300
DBNodeClass	string	Spesifikasi node.	E8
LockReason	string	Alasan kluster dikunci. Catatan Parameter ini hanya dikembalikan ketika kluster dikunci. Nilainya selalu instance_expire.	instance_expired
VPCId	string	ID virtual private cloud (VPC).	vpc-bp13h7uzhulpuxvnp****
ComputeResource	string	Spesifikasi sumber daya komputasi yang digunakan dalam kluster ber-mode fleksibel. Sumber daya ini digunakan untuk komputasi data. Anda dapat menambahkan sumber daya komputasi untuk mempercepat kueri. Anda dapat mengubah ukuran sumber daya berdasarkan kinerja aktual kluster.	8Core32GB
RegionId	string	ID wilayah kluster.	cn-hangzhou
ElasticIOResource	integer	Jumlah sumber daya I/O elastis.	2
VSwitchId	string	ID vSwitch.	vsw-bp1syh8vvw8yech7n****
DBVersion	string	Versi database. Hanya versi 3.0 yang didukung.	3.0
VPCCloudInstanceId	string	ID instans VPC.	am-bp111m2cfrdl1****-controller
DBClusterStatus	string	Status kluster. Untuk informasi selengkapnya, lihat Status kluster.	Running
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmyiu4ekp****
DBClusterNetworkType	string	Jenis jaringan kluster. Hanya VPC yang didukung.	vpc
DBClusterDescription	string	Deskripsi kluster.	adb_test
UserENIStatus	boolean	Menunjukkan apakah Elastic Network Interface (ENI) diaktifkan. Nilai yang valid: true: Diaktifkan. false: Dinonaktifkan.	true
ZoneId	string	ID zona kluster.	cn-hangzhou-h
Category	string	Edisi kluster. Nilai yang valid: BASIC: Edisi Dasar untuk mode reservasi CLUSTER: Edisi Kluster untuk mode reservasi MIXED_STORAGE: Edisi Kluster untuk mode fleksibel (baru) Catatan Untuk informasi selengkapnya tentang edisi kluster, lihat Edisi.	MIXED_STORAGE
Engine	string	Mesin database kluster. Nilainya tetap AnalyticDB.	AnalyticDB
KmsId	string	ID kunci yang digunakan untuk mengenkripsi data disk. Catatan Parameter ini hanya dikembalikan ketika enkripsi disk diaktifkan untuk kluster AnalyticDB for MySQL.	e1935511-cf88-1123-a0f8-1be8d251****
InnerIp	string	Alamat IP publik.	10.1.XX.XX
InnerPort	string	Nomor port publik.	3306
DiskPerformanceLevel	string	Tingkat kinerja disk.	PL1
ElasticIOResourceSize	string	Spesifikasi satu node sumber daya elastis. Nilai yang valid: 8Core64GB: Jika spesifikasi satu node adalah 8-core 64 GB, maka spesifikasi satu grup sumber daya I/O elastis adalah 24-core 192 GB. 12Core96GB: Jika spesifikasi satu node adalah 12-core 96 GB, maka spesifikasi satu grup sumber daya I/O elastis adalah 36-core 288 GB.	8Core64GB
DiskEncryption	boolean	Menunjukkan apakah enkripsi disk diaktifkan. Nilai yang valid: true: ya. false: tidak.	false
TaskInfo	object	Informasi tugas.
Name	string	Nama tugas.	analyticDBFlexibleScaleOut
Status	string	Status tugas. Nilai yang valid: NOT_RUN: Tertunda. RUNNING: Berjalan. SUCCEED: Berhasil.	RUNNING
Progress	string	Kemajuan tugas. Satuan: %.	10
StepList	object
StepList	array<object>	Langkah-langkah tugas.
	object	Langkah tugas.
StepName	string	Nama langkah.	ApplyResource
StepDesc	string	Deskripsi langkah.	Apply resource
StepStatus	string	Status langkah. Nilai yang valid: NOT_RUN: Tertunda. RUNNING: Berjalan. SUCCEED: Berhasil.	SUCCEED
StepProgress	string	Kemajuan langkah. Satuan: %.	50
StartTime	string	Waktu mulai langkah. Format waktunya adalah YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	Waktu selesai langkah. Format waktunya adalah YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
ProductVersion	string	Versi produk. Nilai yang valid: BasicVersion: Edisi Dasar. EnterpriseVersion: Edisi Perusahaan.	BasicVersion
SecondaryZoneId	string	ID zona sekunder. Catatan Nilai parameter ini tidak boleh sama dengan nilai parameter ZoneId.	cn-hangzhou-i
SecondaryVSwitchId	string	ID vSwitch sekunder. Catatan Nilai parameter ini tidak boleh sama dengan nilai parameter VSwitchId.	vsw-0jlxwqt4531fsb3jdzx6h
ReservedNodeSize	string	Spesifikasi node reservasi. Satuan: AnalyticDB Compute Unit (ACU).	8ACU
ReservedNodeCount	integer	Jumlah node sumber daya reservasi.	3
ProductForm	string	Bentuk produk. Nilai yang valid: LegacyForm: Bentuk lama. IntegrationForm: Bentuk terintegrasi.	IntegrationForm

Contoh

Respons sukses

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",
        "SecondaryZoneId": "cn-hangzhou-i",
        "SecondaryVSwitchId": "vsw-0jlxwqt4531fsb3jdzx6h",
        "ReservedNodeSize": "8ACU",
        "ReservedNodeCount": 3,
        "ProductForm": "IntegrationForm"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.