All Products
Search

This Product

    :Encrypt

    Document Center

    :Encrypt

    Last Updated:Dec 21, 2025

    Mengenkripsi plaintext menjadi ciphertext menggunakan kunci simetris.

    Deskripsi operasi

    Persiapan

    • Untuk informasi mengenai kebijakan akses yang diperlukan agar pengguna RAM atau peran RAM dapat memanggil operasi API ini, lihat Resource Access Management.

    • Anda dapat memanggil operasi ini melalui shared gateway atau dedicated gateway. Untuk informasi selengkapnya, lihat Alibaba Cloud SDK.

      • Shared gateway: Anda dapat mengakses KMS melalui Internet atau VPC. Untuk menggunakan metode ini, Anda harus mengaktifkan akses Internet. Untuk informasi selengkapnya, lihat Mengakses kunci dalam instans KMS melalui Internet.

      • Dedicated gateway: Anda dapat mengakses KMS menggunakan private endpoint KMS (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).

    Batas QPS

    • Jika Anda menggunakan shared gateway untuk memanggil operasi ini, batas queries per second (QPS) untuk satu pengguna adalah 1.000. Jika batas ini dilampaui, panggilan API akan mengalami throttling, yang dapat memengaruhi bisnis Anda. Kami menyarankan agar Anda memanggil operasi ini dengan laju yang wajar untuk menghindari throttling.

    • Jika Anda menggunakan dedicated gateway untuk memanggil operasi ini, batas QPS untuk satu pengguna bergantung pada spesifikasi kinerja komputasi instans KMS Anda. Untuk informasi selengkapnya, lihat Metrik kinerja.

    Deskripsi

    • KMS mengenkripsi data yang ditentukan menggunakan versi primary dari kunci yang ditentukan.

    • Anda dapat mengenkripsi hingga 6 KB data, seperti kunci RSA, password database, atau informasi sensitif lainnya.

    • Jika Anda memigrasikan data terenkripsi dari satu Wilayah ke Wilayah lain, Anda dapat memanggil operasi Encrypt di Wilayah tujuan untuk mengenkripsi ulang kunci data plaintext dari Wilayah sumber. Hal ini akan menghasilkan kunci data terenkripsi baru. Anda kemudian dapat memanggil operasi Decrypt untuk mendekripsi kunci baru tersebut di Wilayah tujuan.

    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
    KeyId

    string

    Yes

    ID kunci. Anda juga dapat menentukan alias atau Amazon Resource Name (ARN) kunci tersebut. Untuk informasi selengkapnya mengenai alias, lihat Mengelola alias.

    Catatan

    Saat Anda mengakses kunci di Akun Alibaba Cloud lain, Anda harus menentukan ARN kunci tersebut. ARN kunci memiliki format acs:kms:${region}:${account}:key/${keyid}.

    key-hzz630494463ejqjx****
    Plaintext

    string

    Yes

    Plaintext yang akan dienkripsi. Plaintext harus dikodekan dalam Base64.

    SGVsbG8gd29y****
    EncryptionContext

    object

    No

    String JSON yang terdiri atas pasangan kunci-nilai. Jika Anda menentukan parameter ini, Anda harus menentukan parameter yang sama saat memanggil operasi Decrypt. Untuk informasi selengkapnya, lihat EncryptionContext.

    {"Example":"Example"}
    DryRun

    string

    No

    Menentukan apakah fitur dry run diaktifkan.

    • true: mengaktifkan fitur dry run.

    • false (default): menonaktifkan fitur dry run.

    Fitur dry run digunakan untuk menguji pemanggilan API dan memverifikasi izin terhadap resource yang Anda miliki serta validitas parameter permintaan. Anda dapat melihat hasil pemeriksaan dalam respons.

    • DryRunOperationError: Izin dan parameter valid. Jika Anda tidak menentukan parameter DryRun, permintaan akan berhasil.

    • ValidationError: Parameter dalam permintaan tidak valid.

    • AccessDeniedError: Anda tidak memiliki otorisasi untuk melakukan operasi ini pada resource KMS.

    false

    Elemen respons

    Element

    Type

    Description

    Example

    object

    KeyVersionId

    string

    ID versi kunci yang digunakan untuk mengenkripsi plaintext. Ini adalah versi primary dari kunci yang ditentukan.

    86a9efd9-3d16-4894-bd4f-1fc43f3f****
    KeyId

    string

    ID kunci. Jika Anda menggunakan alias atau ARN kunci dalam permintaan, ID kunci tersebut akan dikembalikan.

    key-hzz630494463ejqjx****
    CiphertextBlob

    string

    Ciphertext dari data yang dienkripsi menggunakan versi primary dari kunci yang ditentukan.

    DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****
    RequestId

    string

    ID permintaan, yaitu pengenal unik yang dihasilkan oleh Alibaba Cloud untuk permintaan tersebut. Anda dapat menggunakan ID ini untuk memecahkan masalah.

    475f1620-b9d3-4d35-b5c6-3fbdd941423d

    Contoh

    Respons sukses

    JSONformat

    {
  "KeyVersionId": "86a9efd9-3d16-4894-bd4f-1fc43f3f****",
  "KeyId": "key-hzz630494463ejqjx****",
  "CiphertextBlob": "DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****",
  "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter The specified parameter is invalid. An invalid value is specified for the parameter.
    404 Forbidden.KeyNotFound The specified Key is not found. The error message returned because the specified CMK does not exist.
    404 Forbidden.AliasNotFound The specified Alias is not found. The error message returned because the specified alias does not exist.
    404 InvalidAccessKeyId.NotFound The Access Key ID provided does not exist in our records.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.