AsymmetricEncrypt - Key Management Service - Alibaba Cloud Documentation Center

Deskripsi operasi

Persiapan

Untuk informasi mengenai izin yang diperlukan untuk memanggil operasi ini, lihat Resource Access Management.
Anda dapat memanggil operasi ini melalui gateway bersama atau gateway khusus. Untuk informasi selengkapnya, lihat Alibaba Cloud SDK.
- Gateway bersama: Anda dapat mengakses KMS melalui Internet atau menggunakan nama domain VPC. Untuk mengakses KMS melalui Internet, Anda harus mengaktifkan akses Internet. Untuk informasi selengkapnya, lihat Akses kunci dalam instans KMS melalui Internet.
- Gateway khusus: Anda dapat mengakses KMS menggunakan titik akhir pribadi KMS (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).

Batas QPS

Jika menggunakan gateway bersama: Jumlah permintaan per detik (QPS) untuk satu pengguna dibatasi hingga 200. Jika batas ini dilampaui, panggilan API akan dikenai pengendalian aliran, yang dapat memengaruhi bisnis Anda. Kami menyarankan agar Anda merencanakan panggilan API guna menghindari melebihi batas tersebut.
Jika menggunakan gateway khusus: Batas QPS untuk satu pengguna bergantung pada spesifikasi kinerja komputasi instans KMS Anda. Untuk informasi selengkapnya, lihat Metrik kinerja.

Deskripsi

Operasi ini hanya mendukung kunci asimetris yang memiliki parameter Usage diatur ke ENCRYPT/DECRYPT. Tabel berikut menjelaskan algoritma enkripsi yang didukung.

KeySpec	Algorithm	Description	Jumlah maksimum byte yang dapat dienkripsi
RSA_2048	RSAES_OAEP_SHA_256	RSAES-OAEP menggunakan SHA-256 dan MGF1 dengan SHA-256	190
RSA_2048	RSAES_OAEP_SHA_1	RSAES-OAEP menggunakan SHA1 dan MGF1 dengan SHA1	214
RSA_3072	RSAES_OAEP_SHA_256	RSAES-OAEP menggunakan SHA-256 dan MGF1 dengan SHA-256	318
RSA_3072	RSAES_OAEP_SHA_1	RSAES-OAEP menggunakan SHA1 dan MGF1 dengan SHA1	342
EC_SM2	SM2PKE	Algoritma enkripsi kunci publik kurva elips SM2	6047

Dalam contoh ini, teks biasa SGVsbG8gd29ybGQ= dienkripsi menggunakan kunci asimetris dengan ID kunci key-hzz630494463ejqjx****, ID versi kunci 2ab1a983-7072-4bbc-a582-584b5bd8****, dan algoritma enkripsi RSAES_OAEP_SHA_1.

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
Plaintext	string	Yes	Teks biasa yang akan dienkripsi. Nilainya harus dikodekan dalam Base64.	SGVsbG8gd29ybGQ=
KeyId	string	Yes	ID kunci. Anda juga dapat menentukan alias atau Nama Sumber Daya Alibaba Cloud (ARN) dari kunci tersebut. Untuk informasi selengkapnya tentang alias, lihat Kelola alias. Catatan Untuk mengakses kunci milik Akun Alibaba Cloud lain, Anda harus menentukan ARN kunci tersebut. Format ARN kunci adalah `acs:kms:${region}:${account}:key/${keyid}`.	key-hzz630494463ejqjx****
KeyVersionId	string	Yes	ID versi kunci. ID tersebut harus berupa pengidentifikasi unik global. Catatan Anda dapat memanggil operasi ListKeyVersions untuk mendapatkan ID versi kunci.	2ab1a983-7072-4bbc-a582-584b5bd8****
Algorithm	string	Yes	Algoritma enkripsi.	RSAES_OAEP_SHA_1
DryRun	string	No	Menentukan apakah fitur dry run diaktifkan. true: mengaktifkan fitur tersebut. false (default): menonaktifkan fitur tersebut. Fitur dry run digunakan untuk menguji panggilan API dan memverifikasi izin pada sumber daya yang ditentukan serta validitas parameter permintaan. Jika Anda mengaktifkan fitur dry run, KMS selalu mengembalikan hasil gagal beserta alasan kegagalannya. Alasan kegagalan tersebut meliputi: DryRunOperationError: Permintaan akan berhasil jika parameter DryRun tidak ditentukan. ValidationError: Parameter yang ditentukan 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	Nomor versi kunci utama yang digunakan untuk mengenkripsi teks biasa.	2ab1a983-7072-4bbc-a582-584b5bd8****
KeyId	string	ID kunci. Jika Anda menentukan alias atau ARN kunci dalam permintaan, ID kunci tersebut akan dikembalikan.	key-hzz630494463ejqjx****
CiphertextBlob	string	Teks terenkripsi dari data yang telah dienkripsi. Nilainya dikodekan dalam Base64.	BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==
RequestId	string	ID permintaan, yaitu pengidentifikasi unik yang dihasilkan oleh Alibaba Cloud untuk permintaan tersebut. Anda dapat menggunakan ID permintaan ini untuk memecahkan masalah.	475f1620-b9d3-4d35-b5c6-3fbdd941423d

Contoh

Respons sukses

JSONformat

{
  "KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
  "KeyId": "key-hzz630494463ejqjx****",
  "CiphertextBlob": "BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==",
  "RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d"
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Rejected.UnsupportedOperation	Unsupported operation.	The operation is not supported.
404	Forbidden.AliasNotFound	The specified Alias is not found.	The error message returned because the specified alias does not exist.
404	Forbidden.KeyNotFound	The specified Key is not found.	The error message returned because the specified CMK does not exist.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.