Identity and Access Management API, gRPC: KeyService.Update

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

Yandex Cloud

Обновлена 27 мая 2026 г.

gRPC request
UpdateKeyRequest
operation.Operation

Updates the specified key pair.

gRPC request

rpc Update (UpdateKeyRequest) returns (operation.Operation)

UpdateKeyRequest

{
  "key_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "description": "string"
}

Field	Description
key_id	string Required field. ID of the Key resource to update. To get key pair ID, use a KeyService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the Key resource are going to be updated.
description	string Description of the key pair. The maximum string length in characters is 256.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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	google.protobuf.Any 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	google.protobuf.Any 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.

Identity and Access Management API, gRPC: KeyService.Update

gRPC requestgRPC request

UpdateKeyRequestUpdateKeyRequest

operation.Operationoperation.Operation

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

gRPC request

UpdateKeyRequest

operation.Operation