Key Management Service API, gRPC: SymmetricKeyService.CancelVersionDestruction

Статья создана

Yandex Cloud

Обновлена 26 ноября 2024 г.

gRPC request
CancelSymmetricKeyVersionDestructionRequest
operation.Operation
CancelSymmetricKeyVersionDestructionMetadata
SymmetricKeyVersion

Cancels previously scheduled version destruction, if the version hasn't been destroyed yet.

gRPC request

rpc CancelVersionDestruction (CancelSymmetricKeyVersionDestructionRequest) returns (operation.Operation)

CancelSymmetricKeyVersionDestructionRequest

{
  "key_id": "string",
  "version_id": "string"
}

Field

Description

key_id

string

Required field. ID of the key to cancel a version's destruction for.

version_id

string

Required field. ID of the version whose scheduled destruction should be cancelled.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "key_id": "string",
    "version_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "key_id": "string",
    "status": "Status",
    "algorithm": "SymmetricAlgorithm",
    "created_at": "google.protobuf.Timestamp",
    "primary": "bool",
    "destroy_at": "google.protobuf.Timestamp",
    "hosted_by_hsm": "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.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	CancelSymmetricKeyVersionDestructionMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	SymmetricKeyVersion The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

CancelSymmetricKeyVersionDestructionMetadata

Field

Description

key_id

string

ID of the key whose version's destruction is being cancelled.

version_id

string

ID of the version whose scheduled destruction is being cancelled.

SymmetricKeyVersion

Symmetric KMS key version: metadata about actual cryptographic data.

Field	Description
id	string ID of the key version.
key_id	string ID of the symmetric KMS key that the version belongs to.
status	enum Status Status of the key version. `STATUS_UNSPECIFIED` `ACTIVE`: The version is active and can be used for encryption and decryption. `SCHEDULED_FOR_DESTRUCTION`: The version is scheduled for destruction, the time when it will be destroyed is specified in the `SymmetricKeyVersion.destroy_at` field. `DESTROYED`: The version is destroyed and cannot be recovered.
algorithm	enum SymmetricAlgorithm Encryption algorithm that should be used when using the key version to encrypt plaintext. `SYMMETRIC_ALGORITHM_UNSPECIFIED` `AES_128`: AES algorithm with 128-bit keys. `AES_192`: AES algorithm with 192-bit keys. `AES_256`: AES algorithm with 256-bit keys. `AES_256_HSM`: AES algorithm with 256-bit keys hosted by HSM
created_at	google.protobuf.Timestamp Time when the key version was created.
primary	bool Indication of a primary version, that is to be used by default for all cryptographic operations that don't have a key version explicitly specified.
destroy_at	google.protobuf.Timestamp Time when the key version is going to be destroyed. Empty unless the status is `SCHEDULED_FOR_DESTRUCTION`.
hosted_by_hsm	bool Indication of the version that is hosted by HSM.

Key Management Service API, gRPC: SymmetricKeyService.CancelVersionDestruction

gRPC requestgRPC request

CancelSymmetricKeyVersionDestructionRequestCancelSymmetricKeyVersionDestructionRequest

operation.Operationoperation.Operation

CancelSymmetricKeyVersionDestructionMetadataCancelSymmetricKeyVersionDestructionMetadata

SymmetricKeyVersionSymmetricKeyVersion

Была ли статья полезна?

gRPC request

CancelSymmetricKeyVersionDestructionRequest

operation.Operation

CancelSymmetricKeyVersionDestructionMetadata

SymmetricKeyVersion