Gunakan DescribeDBClusterAttribute untuk mengkueri atribut kluster - AnalyticDB

Operasi ini mengembalikan detail kluster tertentu.

Deskripsi operasi

Untuk informasi mengenai endpoint layanan ini, lihat 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:DescribeDBClusterAttribute

get

*DBClusterLakeVersion

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster Edisi Data Lakehouse. Catatan Anda dapat memanggil operasi DescribeDBClusters untuk mendapatkan ID kluster.	amv-wz9509beptiz****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	A5C433C2-001F-58E3-99F5-3274C14DF8BD
Items	object
DBCluster	array<object>	Daftar informasi kluster untuk Edisi Data Lakehouse.
	array<object>	Detail kluster.
CreationTime	string	Waktu pembuatan kluster. Waktu dalam UTC dengan format `yyyy-MM-ddThh:mm:ssZ`.	2022-07-01T09:50:18Z
Expired	string	Menunjukkan apakah kluster langganan telah kedaluwarsa. Nilai yang valid: true: Kluster telah kedaluwarsa. false: Kluster belum kedaluwarsa. Catatan Jika kluster telah kedaluwarsa, kluster tersebut akan dikunci atau bahkan dirilis setelah periode tertentu. Perpanjang masa berlaku kluster tersebut. Untuk informasi selengkapnya, lihat Kebijakan perpanjangan. Parameter ini tidak dikembalikan untuk kluster pay-as-you-go.	false
MaintainTime	string	Jendela pemeliharaan kluster. Waktu dalam UTC dengan format `HH:mmZ-HH:mmZ`. Catatan Untuk informasi selengkapnya mengenai jendela pemeliharaan, lihat Atur jendela pemeliharaan.	04:00Z-05:00Z
PayType	string	Metode penagihan kluster. Nilai yang valid: Postpaid: pay-as-you-go. Prepaid: subscription.	Prepaid
Tags	object
Tag	array<object>	Daftar tag.
	object
Key	string	Kunci tag. Catatan Panggil operasi TagResources untuk membuat tag pada kluster tujuan.	tag1
Value	string	Nilai tag.	test1
Mode	string	Mode kluster. Secara default, flexible dikembalikan, yang menunjukkan kluster elastis.	flexible
Port	integer	Nomor port kluster.	3306
LockMode	string	Mode penguncian kluster. Nilai yang valid: Unlock: Kluster tidak terkunci. ManualLock: Kluster dikunci secara manual. LockByExpiration: Kluster dikunci otomatis saat kedaluwarsa.	ManualLock
EngineVersion	string	Versi mesin database kluster.	3.1.16
StorageResource	string	Jumlah resource penyimpanan yang dialokasikan. Satu AnalyticDB Compute Unit (ACU) setara dengan 1 core dan 4 GB memori. Resource penyimpanan digunakan untuk membaca dan menulis data. Meningkatkan resource penyimpanan akan meningkatkan performa baca-tulis kluster.	24ACU
DBClusterId	string	ID kluster untuk Edisi Perusahaan, Edisi Dasar, atau Edisi Data Lakehouse. ID kluster untuk Edisi Data Lakehouse.	amv-wz9509beptiz****
ConnectionString	string	Titik akhir VPC kluster.	amv-wz9509beptiz****.ads.aliyuncs.com
DBClusterType	string	Jenis kluster. Secara default, Common dikembalikan, yang menunjukkan kluster reguler.	Common
CommodityCode	string	Kode komoditas kluster. Nilai yang valid: ads: pay-as-you-go. ads_pre: subscription.	ads_pre
ExpireTime	string	Waktu kedaluwarsa kluster. Untuk kluster subscription, waktu kedaluwarsa dikembalikan. Untuk kluster pay-as-you-go, parameter ini kosong.	2022-10-01T09:50:18Z
LockReason	string	Alasan mengapa kluster dikunci. Catatan Parameter ini hanya dikembalikan ketika kluster dikunci. Nilainya tetap instance_expire.	instance_expire
VPCId	string	ID virtual private cloud (VPC).	vpc-bp13h7uzhulpu****
ComputeResource	string	Jumlah resource komputasi yang dialokasikan. Satu AnalyticDB Compute Unit (ACU) setara dengan 1 core dan 4 GB memori. Resource komputasi digunakan untuk perhitungan data. Meningkatkan resource komputasi dapat mempercepat kueri. Resource ini dapat diskalakan secara elastis berdasarkan performa aktual kluster.	16ACU
RegionId	string	ID wilayah kluster.	cn-hangzhou
VSwitchId	string	ID vSwitch.	vsw-uf629gydd54ld****
DBVersion	string	Versi kluster AnalyticDB for MySQL. Hanya versi 5.0 yang didukung.	5.0
DBClusterStatus	string	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 backup. ClassChanging: Spesifikasi kluster sedang diubah. NetAddressCreating: Koneksi jaringan sedang dibuat. NetAddressDeleting: Koneksi jaringan sedang dihapus. NetAddressModifying: Koneksi jaringan sedang dimodifikasi.	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.	false
ZoneId	string	ID zona kluster.	cn-hangzhou-h
Engine	string	Mesin database kluster. Nilainya tetap AnalyticDB.	AnalyticDB
ReservedACU	string	Jumlah sisa resource komputasi yang dialokasikan dalam kluster. Satu AnalyticDB Compute Unit (ACU) setara dengan 1 core dan 4 GB memori.	24ACU
ComputeResourceTotal	string	Total jumlah resource komputasi dalam kluster. Satu AnalyticDB Compute Unit (ACU) setara dengan 1 core dan 4 GB memori.	48ACU
StorageResourceTotal	string	Total jumlah resource penyimpanan dalam kluster. Satu AnalyticDB Compute Unit (ACU) setara dengan 1 core dan 4 GB memori.	24ACU
SupportedFeatures	object	Parameter ini dicadangkan.
	string	Parameter ini dicadangkan.	预留参数，不涉及。
ProductForm	string	Parameter ini dicadangkan.	预留参数，不涉及。
ReservedNodeSize	string	Parameter ini dicadangkan.	预留参数，不涉及。
ReservedNodeCount	integer	Parameter ini dicadangkan.	预留参数，不涉及。
ClickhouseEngineEnabled	boolean	Menunjukkan apakah mesin tabel lebar ClickHouse diaktifkan. true: Mesin tabel lebar ClickHouse diaktifkan. false: Mesin tabel lebar ClickHouse tidak diaktifkan. Valid values: true : true false : false	true
AINodeNumber	integer
ProductVersion	string	Edisi kluster. Nilai yang valid: BasicVersion: Edisi Dasar. EnterpriseVersion: Edisi Perusahaan.	BasicVersion
KmsId	string	ID kunci yang digunakan untuk mengenkripsi data disk. Catatan Parameter ini hanya dikembalikan jika enkripsi disk diaktifkan untuk kluster AnalyticDB for MySQL.	e1935511-cf88-1123-a0f8-1be8d251****
TaskInfo	object	Informasi tugas.
Name	string	Nama tugas.	ScaleUpDBCluster
Status	string	Status tugas. Nilai yang valid: NOT_RUN: Tugas sedang menunggu untuk dijalankan. RUNNING: Tugas sedang berjalan. SUCCEED: Tugas selesai.	RUNNING
Progress	string	Kemajuan tugas dalam persentase.	10
StepList	object
StepList	array<object>	Daftar langkah-langkah tugas.
	object	Detail langkah.
StepName	string	Nama langkah.	PrepareResources
StepDesc	string	Deskripsi langkah.	Prepare resources
StepStatus	string	Status langkah. Nilai yang valid: NOT_RUN: Langkah sedang menunggu untuk dijalankan. RUNNING: Langkah sedang berjalan. SUCCEED: Langkah selesai.	RUNNING
StepProgress	string	Kemajuan langkah dalam persentase.	50
StartTime	string	Waktu mulai langkah. Formatnya adalah YYYY-MM-DDThh:mm:ssZ.	2024-03-10T09:28:34Z
EndTime	string	Waktu selesai langkah. Formatnya adalah YYYY-MM-DDThh:mm:ssZ.	2024-03-10T10:28:34Z
UserENIVpcId	string	ID VPC tempat ENI berada.	vpc-rj9hnedlfm645uj******
UserENIVSwitchOptions	string	Daftar vSwitch untuk ENI yang dipisahkan koma.	vsw-rj9ixufmywqq98z****,vsw-rj95ij6wcz656v7****
UserENIZoneOptions	string	Daftar zona untuk ENI yang dipisahkan koma.	cn-hangzhou-k,cn-hangzhou-h
SecondaryZoneId	string
SecondaryVSwitchId	string
DiskEncryption	boolean
ClickhouseEngineCacheSize	integer	Ukuran cache mesin tabel lebar ClickHouse, dalam GB. Nilai -1 menunjukkan bahwa mesin tabel lebar tidak diaktifkan. Angka lain menunjukkan ukuran cache disk.	100
AINodeSpec	string

Contoh

Respons sukses

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": "预留参数，不涉及。"
        },
        "ProductForm": "预留参数，不涉及。",
        "ReservedNodeSize": "预留参数，不涉及。",
        "ReservedNodeCount": 0,
        "ClickhouseEngineEnabled": true,
        "AINodeNumber": 0,
        "ProductVersion": "BasicVersion",
        "KmsId": "e1935511-cf88-1123-a0f8-1be8d251****",
        "TaskInfo": {
          "Name": "ScaleUpDBCluster",
          "Status": "RUNNING",
          "Progress": "10",
          "StepList": {
            "StepList": [
              {
                "StepName": "PrepareResources",
                "StepDesc": "Prepare resources",
                "StepStatus": "RUNNING",
                "StepProgress": "50",
                "StartTime": "2024-03-10T09:28:34Z",
                "EndTime": "2024-03-10T10:28:34Z"
              }
            ]
          }
        },
        "UserENIVpcId": "vpc-rj9hnedlfm645uj******",
        "UserENIVSwitchOptions": "vsw-rj9ixufmywqq98z******,vsw-rj95ij6wcz656v7******",
        "UserENIZoneOptions": "cn-hangzhou-k,cn-hangzhou-h",
        "SecondaryZoneId": "",
        "SecondaryVSwitchId": "",
        "DiskEncryption": false,
        "ClickhouseEngineCacheSize": 100,
        "AINodeSpec": ""
      }
    ]
  }
}

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.