Key Management Service API, gRPC: SymmetricKeyService.ScheduleVersionDestruction
Schedules the specified key version for destruction.
Scheduled destruction can be cancelled with the SymmetricKeyService.CancelVersionDestruction method.
gRPC request
rpc ScheduleVersionDestruction (ScheduleSymmetricKeyVersionDestructionRequest) returns (operation.Operation)
ScheduleSymmetricKeyVersionDestructionRequest
{
"keyId": "string",
"versionId": "string",
"pendingPeriod": "google.protobuf.Duration"
}
Field |
Description |
keyId |
string Required field. ID of the key whose version should be scheduled for destruction. |
versionId |
string Required field. ID of the version to be destroyed. |
pendingPeriod |
Time interval between the version destruction request and actual destruction. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"keyId": "string",
"versionId": "string",
"destroyAt": "google.protobuf.Timestamp"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"keyId": "string",
"status": "Status",
"algorithm": "SymmetricAlgorithm",
"createdAt": "google.protobuf.Timestamp",
"primary": "bool",
"destroyAt": "google.protobuf.Timestamp",
"hostedByHsm": "bool"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
ScheduleSymmetricKeyVersionDestructionMetadata Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
ScheduleSymmetricKeyVersionDestructionMetadata
Field |
Description |
keyId |
string ID of the key whose version is being scheduled for destruction. |
versionId |
string ID of the version that is being scheduled for destruction. |
destroyAt |
Time when the version is scheduled to be destroyed. |
SymmetricKeyVersion
Symmetric KMS key version: metadata about actual cryptographic data.
Field |
Description |
id |
string ID of the key version. |
keyId |
string ID of the symmetric KMS key that the version belongs to. |
status |
enum Status Status of the key version.
|
algorithm |
enum SymmetricAlgorithm Encryption algorithm that should be used when using the key version to encrypt plaintext.
|
createdAt |
Time when the key version was created. |
primary |
bool Indication of a primary version, that is to be used by default for all cryptographic |
destroyAt |
Time when the key version is going to be destroyed. Empty unless the status |
hostedByHsm |
bool Indication of the version that is hosted by HSM. |