All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeDBInstanceEncryptionKey

    Document Center

    ApsaraDB for MongoDB:DescribeDBInstanceEncryptionKey

    Last Updated:Jun 10, 2026

    Mengkueri kunci enkripsi instans MongoDB.

    Deskripsi operasi

    Saat Anda memanggil operasi DescribeDBInstanceEncryptionKey, instans harus memiliki transparent data encryption (TDE) yang diaktifkan dalam mode BYOK. Anda dapat memanggil operasi ModifyDBInstanceTDE untuk mengaktifkan TDE.

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

    get

    *Instance

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    DBInstanceId

    string

    Yes

    ID instans.

    dds-bp2235****
    EncryptionKey

    string

    No

    Kunci kustom untuk instans. Anda dapat memanggil operasi DescribeUserEncryptionKeyList untuk mengkueri daftar kunci kustom untuk instans ApsaraDB for MongoDB.

    2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Data yang dikembalikan.

    Origin

    string

    Sumber kunci untuk instans.

    Aliyun_KMS
    Description

    string

    Deskripsi kunci untuk instans.

    key description example
    RequestId

    string

    ID permintaan.

    783C2062-A2D3-4EA8-88AD-E43F990C23BB
    EncryptionKeyStatus

    string

    Menunjukkan apakah kunci untuk instans diaktifkan. Nilai yang valid:

    • Enabled

    • Disabled

    Enabled
    MaterialExpireTime

    string

    Waktu kedaluwarsa kunci untuk instans. Waktu ditampilkan dalam UTC. Jika parameter dibiarkan kosong, kunci untuk instans tidak akan kedaluwarsa.

    2020-07-06T18:22:03Z
    KeyUsage

    string

    Tujuan kunci untuk instans.

    ENCRYPT/DECRYPT
    EncryptionKey

    string

    Kunci untuk instans.

    2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    Creator

    string

    UID pembuat kunci.

    123456
    DeleteDate

    string

    Waktu terjadwal saat kunci untuk instans akan dihapus. Jika parameter dibiarkan kosong, kunci tidak akan dihapus.

    2020-07-06T18:22:03Z

    Contoh

    Respons sukses

    JSONformat

    {
  "Origin": "Aliyun_KMS",
  "Description": "key description example",
  "RequestId": "783C2062-A2D3-4EA8-88AD-E43F990C23BB",
  "EncryptionKeyStatus": "Enabled",
  "MaterialExpireTime": "2020-07-06T18:22:03Z",
  "KeyUsage": "ENCRYPT/DECRYPT",
  "EncryptionKey": "2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "Creator": "123456",
  "DeleteDate": "2020-07-06T18:22:03Z"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    403 INVALID_INSNAME_REGIONID_EMPTY The insName and regionId can't be all empty
    403 NO_ACTIVE_BYOK This custins no active byok.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.