All Products
Search

This Product

    Key Management Service:SetDeletionProtection

    Document Center

    Key Management Service:SetDeletionProtection

    Last Updated:Jun 10, 2026

    Mengaktifkan atau menonaktifkan proteksi penghapusan untuk customer master key (CMK).

    Deskripsi operasi

    • Untuk informasi lebih lanjut tentang kebijakan akses yang diperlukan bagi pengguna RAM atau peran RAM untuk memanggil operasi API ini, lihat Resource Access Management.

    • Setelah Anda mengaktifkan proteksi penghapusan untuk CMK, Anda tidak dapat menghapusnya. Untuk menghapus CMK, Anda harus terlebih dahulu menonaktifkan proteksi penghapusan.

    • Sebelum Anda memanggil operasi SetDeletionProtection, pastikan bahwa CMK tidak dalam keadaan PendingDeletion. Anda dapat memanggil operasi DescribeKey untuk meminta status dari CMK.

    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

    Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    ProtectedResourceArn

    string

    No

    ARN dari CMK yang ingin Anda konfigurasikan proteksi penghapusannya.
    Anda dapat memanggil operasi DescribeKey untuk meminta ARN dari CMK.

    acs:kms:cn-hangzhou:123213123****:key/0225f411-b21d-46d1-be5b-93931c82****
    EnableDeletionProtection

    boolean

    Yes

    Menentukan apakah akan mengaktifkan proteksi penghapusan. Nilai yang valid:

    • true: mengaktifkan proteksi penghapusan.

    • false: menonaktifkan proteksi penghapusan. Ini adalah nilai default.

    true
    DeletionProtectionDescription

    string

    No

    Deskripsi proteksi penghapusan.

    Catatan

    Parameter ini hanya tersedia ketika EnableDeletionProtection diatur ke true.

    该密钥正在被XXX服务使用。已为您设置删除保护。
    KeyId

    string

    No

    ID dari kunci.

    key-hzz65f3a68554s6ms****
    KmsInstanceId

    string

    No

    Untuk informasi lebih lanjut tentang parameter permintaan umum, lihat Common parameters.

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    ID dari permintaan. ID adalah pengidentifikasi unik yang dihasilkan oleh Alibaba Cloud untuk permintaan tersebut. Anda dapat menggunakan ID untuk memecahkan masalah.

    3455b9b4-95c1-419d-b310-db6a53b09a39

    Contoh

    Respons sukses

    JSONformat

    {
  "RequestId": "3455b9b4-95c1-419d-b310-db6a53b09a39"
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.