Mengambil kunci publik dari kunci asimetris. Anda dapat menggunakan kunci publik tersebut untuk mengenkripsi data atau memverifikasi tanda tangan pada perangkat Anda.
Deskripsi operasi
-
Untuk informasi selengkapnya tentang kebijakan akses yang diperlukan bagi pengguna RAM atau peran RAM untuk memanggil operasi OpenAPI ini, lihat Resource Access Management.
-
Operasi ini mendukung gateway bersama maupun gateway khusus. Untuk informasi selengkapnya, lihat Alibaba Cloud SDK.
-
Gateway bersama: Anda dapat mengakses KMS melalui Internet atau menggunakan nama domain VPC. Jika Anda mengakses KMS melalui Internet, Anda harus mengaktifkan akses Internet. Untuk informasi selengkapnya, lihat Kunci akses pada instans KMS melalui Internet.
-
Gateway khusus: Anda dapat mengakses KMS menggunakan endpoint privat dari KMS (
<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).
-
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| KeyId |
string |
Yes |
Pengidentifikasi unik global dari customer master key (CMK). Parameter ini juga dapat berupa alias yang terikat ke CMK. Untuk informasi selengkapnya, lihat Penggunaan alias. |
5c438b18-05be-40ad-b6c2-3be6752c**** |
| KeyVersionId |
string |
Yes |
Pengidentifikasi unik global dari versi kunci. |
2ab1a983-7072-4bbc-a582-584b5bd8**** |
| DryRun |
string |
No |
Menentukan apakah akan mengaktifkan mode DryRun.
Mode DryRun digunakan untuk menguji panggilan API, memverifikasi izin Anda pada sumber daya, dan memeriksa apakah parameter valid. Jika Anda mengaktifkan mode DryRun, KMS selalu mengembalikan respons yang gagal beserta alasan kegagalan. Alasan kegagalan tersebut meliputi:
|
false |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| KeyVersionId |
string |
Pengidentifikasi unik global dari versi kunci. |
2ab1a983-7072-4bbc-a582-584b5bd8**** |
| KeyId |
string |
Pengidentifikasi unik global dari CMK. Catatan
Jika Anda menentukan alias dari CMK untuk parameter KeyId dalam permintaan, ID dari CMK tempat alias tersebut terikat akan dikembalikan. |
5c438b18-05be-40ad-b6c2-3be6752c**** |
| RequestId |
string |
ID permintaan. |
475f1620-b9d3-4d35-b5c6-3fbdd941423d |
| PublicKey |
string |
Kunci publik dalam format PEM. |
-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs5Yu9AEgATN2/e3nUz1K\nEy6ng8MSPutcse2/VECG/NUF9C6D4IsJ64ShzY3dcn34WYzTOe916eMJFxyrNrSw\nHtc4UOR5AvaoRrfpgu2uq+i70/ZXrWL+pGb1hgZV8cWheIHMxwrR3IiQlM5qN7EF\n9BdyWtyBfUGsp0Bn1VqlPc5G0x0a9xU2z9YtP994yDenNVIoIQ6Cov1lIEuwXAb2\n7boC41ePXwD0JWt41sP+rgCmpjBx00puIG+IlnoReEgI1ZGYmK98GgA/XzmNjZiD\nyvXJZAcM33Ue85+PkR5iHTtSEbi4QAoqpJabprUzz3Fin2j1dRrcacxGb7p31A9c\nJQIDAQAB\n-----END PUBLIC KEY-----\n |
Contoh
Respons sukses
JSONformat
{
"KeyVersionId": "2ab1a983-7072-4bbc-a582-584b5bd8****",
"KeyId": "5c438b18-05be-40ad-b6c2-3be6752c****",
"RequestId": "475f1620-b9d3-4d35-b5c6-3fbdd941423d",
"PublicKey": "-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs5Yu9AEgATN2/e3nUz1K\\nEy6ng8MSPutcse2/VECG/NUF9C6D4IsJ64ShzY3dcn34WYzTOe916eMJFxyrNrSw\\nHtc4UOR5AvaoRrfpgu2uq+i70/ZXrWL+pGb1hgZV8cWheIHMxwrR3IiQlM5qN7EF\\n9BdyWtyBfUGsp0Bn1VqlPc5G0x0a9xU2z9YtP994yDenNVIoIQ6Cov1lIEuwXAb2\\n7boC41ePXwD0JWt41sP+rgCmpjBx00puIG+IlnoReEgI1ZGYmK98GgA/XzmNjZiD\\nyvXJZAcM33Ue85+PkR5iHTtSEbi4QAoqpJabprUzz3Fin2j1dRrcacxGb7p31A9c\\nJQIDAQAB\\n-----END PUBLIC KEY-----\\n"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is not valid. | An invalid value is specified for the parameter. |
| 404 | InvalidAccessKeyId.NotFound | The Access Key ID provided does not exist in our records. | |
| 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.