REST Resource: projects.locations.keyRings.cryptoKeys

Referensi: CryptoKey

CryptoKey mewakili kunci logis yang dapat digunakan untuk operasi kriptografi.

CryptoKey terdiri dari nol atau beberapa versions, yang mewakili materi kunci sebenarnya yang digunakan dalam operasi kriptografi.

Representasi JSON 
{
  "name": string,
  "primary": {
    object (CryptoKeyVersion)
  },
  "purpose": enum (CryptoKeyPurpose),
  "createTime": string,
  "nextRotationTime": string,
  "versionTemplate": {
    object (CryptoKeyVersionTemplate)
  },
  "labels": {
    string: string,
    ...
  },
  "importOnly": boolean,
  "destroyScheduledDuration": string,
  "cryptoKeyBackend": string,

  // Union field rotation_schedule can be only one of the following:
  "rotationPeriod": string
  // End of list of possible types for union field rotation_schedule.
}
Kolom
name

string

Hanya output. Nama resource untuk CryptoKey ini dalam format projects/*/locations/*/keyRings/*/cryptoKeys/*.
primary

object (CryptoKeyVersion)

Hanya output. Salinan CryptoKeyVersion "utama" yang akan digunakan oleh [Encrypt][KeyManagementService.Encrypt] saat CryptoKey ini diberikan di [EncryptRequest.name][].

Versi utama CryptoKey dapat diupdate melalui [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion].

Kunci dengan purpose ENCRYPT_DECRYPT mungkin memiliki kunci utama. Untuk kunci lain, kolom ini akan dihilangkan.
purpose

enum (CryptoKeyPurpose)

Tidak dapat diubah. Tujuan yang tidak dapat diubah dari CryptoKey ini.
createTime

string (Timestamp format)

Hanya output. Waktu saat CryptoKey ini dibuat.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
nextRotationTime

string (Timestamp format)

Di nextRotationTime, Key Management Service akan otomatis:

  1. Buat versi baru dari CryptoKey ini.
  2. Tandai versi baru sebagai utama.

Rotasi kunci yang dilakukan secara manual melalui [CreateCryptoKeyVersion][KeyManagementService.CreateCryptoKeyVersion] dan [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion] tidak memengaruhi nextRotationTime.

Kunci dengan purpose ENCRYPT_DECRYPT mendukung rotasi otomatis. Untuk kunci lain, kolom ini harus dihilangkan.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
versionTemplate

object (CryptoKeyVersionTemplate)

Template yang menjelaskan setelan untuk instance CryptoKeyVersion baru. Properti instance CryptoKeyVersion baru yang dibuat oleh [CreateCryptoKeyVersion][KeyManagementService.CreateCryptoKeyVersion] atau rotasi otomatis dikontrol oleh template ini.
labels

map (key: string, value: string)

Label dengan metadata yang ditentukan pengguna. Untuk mengetahui informasi selengkapnya, lihat Pelabelan Kunci.
importOnly

boolean

Tidak dapat diubah. Apakah kunci ini hanya dapat berisi versi yang diimpor.
destroyScheduledDuration

string (Duration format)

Tidak dapat diubah. Periode waktu yang dihabiskan oleh versi kunci ini dalam status DESTROY_SCHEDULED sebelum bertransisi ke DESTROYED. Jika tidak ditentukan pada waktu pembuatan, durasi default-nya adalah 24 jam.

Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan 's'. Contoh: "3.5s".
cryptoKeyBackend

string

Tidak dapat diubah. Nama resource lingkungan backend tempat materi kunci untuk semua CryptoKeyVersions yang terkait dengan CryptoKey ini berada dan tempat semua operasi kriptografi terkait dilakukan. Hanya berlaku jika CryptoKeyVersions memiliki ProtectionLevel [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], dengan nama resource dalam format projects/*/locations/*/ekmConnections/*. Perlu diperhatikan, daftar ini tidak lengkap dan dapat berlaku untuk ProtectionLevels tambahan pada masa mendatang.
Kolom union rotation_schedule. Mengontrol laju rotasi otomatis. rotation_schedule hanya ada berupa salah satu diantara berikut:
rotationPeriod

string (Duration format)

nextRotationTime akan dimajukan pada periode ini saat layanan merotasi kunci secara otomatis. Minimal 24 jam dan paling lama 876.000 jam.

Jika rotationPeriod ditetapkan, nextRotationTime juga harus ditetapkan.

Kunci dengan purpose ENCRYPT_DECRYPT mendukung rotasi otomatis. Untuk kunci lain, kolom ini harus dihilangkan.

Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan 's'. Contoh: "3.5s".

Metode

getProtectedResourcesSummary

 Menampilkan informasi gabungan tentang resource yang dilindungi oleh CryptoKey Cloud KMS yang ditentukan.