DescribeKey - Key Management Service - Alibaba Cloud Documentation Center

Mengambil informasi mengenai sebuah kunci.

Deskripsi operasi

Anda dapat mengambil informasi mengenai CMK 05754286-3ba2-4fa6-8d41-4323aca6**** dengan menggunakan parameter yang disediakan dalam topik ini. Informasi tersebut mencakup pembuat, waktu pembuatan, status, serta status perlindungan penghapusan CMK tersebut.

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 CMK. ID tersebut harus bersifat unik secara global. Anda juga dapat mengatur parameter ini ke alias yang terikat pada CMK tersebut. Untuk informasi selengkapnya, lihat Ikhtisar alias.	05754286-3ba2-4fa6-8d41-4323aca6****

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan, yang digunakan untuk melokalisasi dan memecahkan masalah.	f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f
KeyMetadata	object	metadata CMK.
DeletionProtection	string	Menunjukkan apakah perlindungan penghapusan diaktifkan. Nilai yang valid: Enabled Disabled	Enabled
KeyId	string	ID CMK. ID tersebut harus bersifat unik secara global.	05754286-3ba2-4fa6-8d41-4323aca6****
NextRotationDate	string	Waktu rotasi berikutnya akan dilakukan. Catatan Parameter ini hanya dikembalikan ketika nilai parameter AutomaticRotation adalah Enabled atau Suspended.	2021-07-06T18:22:03Z
KeyState	string	Status CMK. Untuk informasi selengkapnya, lihat Dampak status CMK terhadap operasi API.	Enabled
RotationInterval	string	Interval rotasi kunci otomatis. Unit: detik. Contohnya, jika nilainya 604800s, rotasi kunci otomatis dilakukan setiap 7 hari. Catatan Parameter ini hanya dikembalikan ketika nilai parameter AutomaticRotation adalah Enabled atau Suspended.	31536000s
Arn	string	Nama Sumber Daya Alibaba Cloud (ARN) dari CMK tersebut.	acs:kms:cn-hangzhou:154035569884**:key/05754286-3ba2-4fa6-8d41-4323aca6**
Creator	string	Akun Alibaba Cloud yang digunakan untuk membuat CMK tersebut.	154035569884****
LastRotationDate	string	Waktu rotasi terakhir dilakukan. Waktu ditampilkan dalam UTC. Untuk CMK baru, nilai parameter ini adalah waktu saat versi awal CMK dihasilkan.	2021-05-20T06:34:21Z
DeleteDate	string	Waktu CMK dijadwalkan untuk dihapus. Waktu ditampilkan dalam UTC. Untuk informasi selengkapnya, lihat ScheduleKeyDeletion. Catatan Parameter ini hanya dikembalikan ketika nilai parameter KeyState adalah PendingDeletion.	2021-05-26T18:22:03Z
PrimaryKeyVersion	string	ID versi kunci utama saat ini untuk CMK simetris.	515e0b0a-624f-45ab-92b5-54f9b551****
Description	string	Deskripsi CMK.	key description example
KeySpec	string	Jenis CMK.	Aliyun_AES_256
Origin	string	Sumber bahan kunci untuk CMK tersebut.	Aliyun_KMS
MaterialExpireTime	string	Waktu kedaluwarsa bahan kunci. Waktu ditampilkan dalam UTC. Jika nilai parameter ini kosong, bahan kunci tidak kedaluwarsa.	2021-07-06T18:22:03Z
DeletionProtectionDescription	string	Deskripsi perlindungan penghapusan.	The CMK is being used by XXX. Deletion protection is set.
AutomaticRotation	string	Menunjukkan apakah rotasi kunci otomatis diaktifkan. Nilai yang valid: Enabled Disabled Suspended Untuk informasi selengkapnya, lihat Rotasi kunci otomatis. Catatan Hanya CMK simetris yang mendukung rotasi kunci otomatis.	Disabled
ProtectionLevel	string	Tingkat perlindungan CMK.	HSM
KeyUsage	string	Penggunaan CMK.	ENCRYPT/DECRYPT
CreationDate	string	Waktu CMK dibuat. Waktu ditampilkan dalam UTC.	2021-05-20T06:34:21Z
DKMSInstanceId	string	ID instans KMS khusus.	kst-bjj62d8f5e0sgtx8h****

Contoh

Respons sukses

JSONformat

{
  "RequestId": "f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f",
  "KeyMetadata": {
    "DeletionProtection": "Enabled",
    "KeyId": "05754286-3ba2-4fa6-8d41-4323aca6****",
    "NextRotationDate": "2021-07-06T18:22:03Z",
    "KeyState": "Enabled",
    "RotationInterval": "31536000s",
    "Arn": "acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6****",
    "Creator": "154035569884****",
    "LastRotationDate": "2021-05-20T06:34:21Z",
    "DeleteDate": "2021-05-26T18:22:03Z",
    "PrimaryKeyVersion": "515e0b0a-624f-45ab-92b5-54f9b551****",
    "Description": "key description example",
    "KeySpec": "Aliyun_AES_256",
    "Origin": "Aliyun_KMS",
    "MaterialExpireTime": "2021-07-06T18:22:03Z",
    "DeletionProtectionDescription": "The CMK is being used by XXX. Deletion protection is set.",
    "AutomaticRotation": "Disabled",
    "ProtectionLevel": "HSM",
    "KeyUsage": "ENCRYPT/DECRYPT",
    "CreationDate": "2021-05-20T06:34:21Z",
    "DKMSInstanceId": "kst-bjj62d8f5e0sgtx8h****"
  }
}

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	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.