ApsaraDB for MongoDB:DescribeUserEncryptionKeyList - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Deskripsi operasi

Anda dapat menggunakan kunci kustom yang diperoleh dengan memanggil DescribeUserEncryptionKeyList untuk mengaktifkan Enkripsi data transparan (TDE). Untuk informasi selengkapnya, lihat ModifyDBInstanceTDE.

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

dds:DescribeUserEncryptionKeyList

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans.	dds-bpxxxxxxxx
TargetRegionId	string	No	ID zona target. Anda dapat memanggil operasi DescribeRegions untuk mengkueri zona yang tersedia.	cn-shanghai
RoleARN	string	No	Nama Sumber Daya Alibaba Cloud (ARN) peran yang ditentukan. Format: `acs:ram::$accountID:role/$roleName` . Nilai default: `acs:ram::$accountID:role/aliyunrdsinstanceencryptiondefaultrole`. Catatan `$accountID`: ID akun Alibaba Cloud. Anda dapat log masuk ke Konsol Manajemen Alibaba Cloud, arahkan kursor ke gambar profil di pojok kanan atas, lalu klik Pengaturan Keamanan untuk melihatnya. `$roleName`: nama Peran RAM. Anda dapat log masuk ke Konsol Resource Access Management (RAM), klik Peran RAM di panel navigasi kiri, lalu lihat nama di daftar nama Peran RAM.	acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	7CD51DA4-A499-43CE-B9B5-20CD4FDC648E
KeyIds	object
KeyId	array	Daftar kunci instans.
	string	Kunci instans.	2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Contoh

Respons sukses

JSONformat

{
  "RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
  "KeyIds": {
    "KeyId": [
      "2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	INVALID_INSNAME_REGIONID_EMPTY	The insName and regionId can't be all empty

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.