REST Resource: projects.locations.keyRings.cryptoKeys

Ressource: CryptoKey

Ein CryptoKey ist ein logischer Schlüssel, der für kryptografische Vorgänge verwendet werden kann.

Eine CryptoKey besteht aus null oder mehr versions, die das tatsächliche Schlüsselmaterial für kryptografische Vorgänge darstellen.

JSON-Darstellung 
{
  "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.
}
Felder
name

string

Nur Ausgabe. Der Ressourcenname für diese CryptoKey im Format projects/*/locations/*/keyRings/*/cryptoKeys/*.
primary

object (CryptoKeyVersion)

Nur Ausgabe. Eine Kopie der „primären“ CryptoKeyVersion, die von [Encrypt][KeyManagementService.Encrypt] verwendet wird, wenn diese CryptoKey in [EncryptRequest.name][] angegeben ist.

Die primäre Version von CryptoKey kann über [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion] aktualisiert werden.

Schlüssel mit purpose ENCRYPT_DECRYPT können einen Primärschlüssel haben. Bei anderen Schlüsseln wird dieses Feld weggelassen.
purpose

enum (CryptoKeyPurpose)

Nicht veränderbar. Der unveränderliche Zweck von CryptoKey.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem dieses CryptoKey erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
nextRotationTime

string (Timestamp format)

Bei nextRotationTime führt der Key Management Service automatisch folgende Schritte aus:

  1. Erstellen Sie eine neue Version von CryptoKey.
  2. Die neue Version wird als primär gekennzeichnet.

Manuell über [CreateCryptoKey][KeyManagementService.CreateCryptoKey] und [UpdateCryptoKeyPrimaryVersion][KeyManagementService.UpdateCryptoKeyPrimaryVersion] durchgeführte Schlüsselrotationen haben keine Auswirkungen auf nextRotationTime.

Schlüssel mit purpose ENCRYPT_DECRYPT unterstützen die automatische Rotation. Bei anderen Schlüsseln muss dieses Feld weggelassen werden.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
versionTemplate

object (CryptoKeyVersionTemplate)

Eine Vorlage, die Einstellungen für neue CryptoKeyVersion-Instanzen beschreibt. Die Attribute neuer CryptoKeyVersion-Instanzen, die entweder von [CreateCryptoKey][KeyManagementService.CreateCryptoKey] oder der automatischen Rotation erstellt wurden, werden von dieser Vorlage gesteuert.
labels

map (key: string, value: string)

Labels mit benutzerdefinierten Metadaten. Weitere Informationen finden Sie unter Schlüssel mit Labeln versehen.
importOnly

boolean

Nicht veränderbar. Gibt an, ob dieser Schlüssel nur importierte Versionen enthalten darf.
destroyScheduledDuration

string (Duration format)

Nicht veränderbar. Der Zeitraum, in dem sich Versionen dieses Schlüssels im Status DESTROY_SCHEDULED befinden, bevor sie zu DESTROYED wechseln. Wenn bei der Erstellung keine Angabe erfolgt, beträgt die Standarddauer 24 Stunden.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
cryptoKeyBackend

string

Nicht veränderbar. Der Ressourcenname der Back-End-Umgebung, in der sich das Schlüsselmaterial für alle mit dieser CryptoKey verknüpften CryptoKeyVersions befindet und in der alle zugehörigen kryptografischen Vorgänge ausgeführt werden. Gilt nur, wenn CryptoKeyVersions die ProtectionLevel [EXTERNAL_VPC][Version.ProtectionLevel.EXTERNAL_VPC] mit dem Ressourcennamen im Format projects/*/locations/*/ekmConnections/* hat. Hinweis: Diese Liste ist nicht vollständig und kann in Zukunft für weitere ProtectionLevels gelten.
Union-Feld rotation_schedule. Steuert die Geschwindigkeit der automatischen Rotation. Für rotation_schedule ist nur einer der folgenden Werte zulässig:
rotationPeriod

string (Duration format)

nextRotationTime wird um diesen Zeitraum verlängert, wenn der Dienst automatisch einen Schlüssel rotiert. Muss mindestens 24 Stunden und darf höchstens 876.000 Stunden betragen.

Wenn rotationPeriod festgelegt ist, muss auch nextRotationTime festgelegt werden.

Schlüssel mit purpose ENCRYPT_DECRYPT unterstützen die automatische Rotation. Bei anderen Schlüsseln muss dieses Feld weggelassen werden.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".

Methoden

getProtectedResourcesSummary

 Gibt aggregierte Informationen zu den Ressourcen zurück, die durch den angegebenen Cloud KMS-CryptoKey geschützt werden.