Referensi API DescribeDBClusterEncryptionKey - PolarDB - Alibaba Cloud - PolarDB

Membuat kueri detail penggunaan kunci untuk klaster PolarDB yang ditentukan.

Deskripsi operasi

Deskripsi

Membuat kueri detail penggunaan kunci untuk klaster PolarDB, seperti ID kunci, status, dan jenis.
Parameter DBClusterId diperlukan. Parameter ini menentukan ID klaster PolarDB yang akan dikueri.
Sebelum Anda memanggil operasi ini, pastikan bahwa peran dan kebijakan Resource Access Management (RAM) yang diperlukan telah dikonfigurasi.

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

polardb:DescribeDBClusterEncryptionKey

get

*All Resource

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
ClientToken	string	No	Token klien untuk memastikan idempotensi permintaan.	6000170000591aed949d0f******************
DBClusterId	string	No	ID klaster. Catatan Panggil Operasi DescribeDBClusters untuk membuat kueri detail semua klaster di akun Anda, termasuk ID klaster.	pc-***

Elemen respons

Element	Type	Description	Example
	object	Isi respons.
RequestId	string	ID permintaan.	137ECCC0-920E-5B3B-9F8E-B81632108BBE
EncryptionKeyList	array<object>	Daftar kunci.
	object	Detail kunci.
AliasName	string	Alias kunci.	alias/your_default_key
Creator	string	UID akun Alibaba Cloud yang membuat kunci.	1****1
DeleteDate	string	Waktu yang dijadwalkan untuk menghapus kunci. Formatnya adalah yyyy-MM-ddTHH:mm:ssZ (UTC). Bidang ini kosong jika kunci tidak dijadwalkan untuk dihapus.	2026-05-08T08:14:16Z
Description	string	Deskripsi kunci.	Description of the key
EncryptionKey	string	ID kunci.	51858179-afb3-4369-8329-*********
EncryptionKeyStatus	string	Status kunci. Nilai yang valid: Enabled: Kunci diaktifkan. Disabled: Kunci tidak diaktifkan.	Enabled
KeyType	string	Jenis kunci. Nilai yang valid: CMK: customer master key ServiceKey: service key	ServiceKey
KeyUsage	string	Tujuan kunci.	ENCRYPT/DECRYPT
MaterialExpireTime	string	Waktu kedaluwarsa kunci. Formatnya adalah yyyy-MM-ddTHH:mm:ssZ (UTC).	2025-10-18T08:14:16Z
Origin	string	Sumber kunci.	Aliyun_KMS
UsedBy	string	Layanan yang menggunakan kunci. Nilai yang valid: TDE: transparent data encryption (TDE). DiskEncryption: disk encryption.	DiskEncryption

Contoh

Respons sukses

JSONformat

{
  "RequestId": "137ECCC0-920E-5B3B-9F8E-B81632108BBE",
  "EncryptionKeyList": [
    {
      "AliasName": "alias/your_default_key",
      "Creator": "1****1",
      "DeleteDate": "2026-05-08T08:14:16Z",
      "Description": "Description of the key",
      "EncryptionKey": "51858179-afb3-4369-8329-*********",
      "EncryptionKeyStatus": "Enabled",
      "KeyType": "ServiceKey",
      "KeyUsage": "ENCRYPT/DECRYPT",
      "MaterialExpireTime": "2025-10-18T08:14:16Z",
      "Origin": "Aliyun_KMS",
      "UsedBy": "DiskEncryption"
    }
  ]
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBInstance.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.