Key Management Service API, REST: SymmetricKey.update
Updates the specified symmetric KMS key.
HTTP request
PATCH https://kms.api.cloud.yandex.net/kms/v1/keys/{keyId}
Path parameters
Parameter | Description |
---|---|
keyId | Required. ID of the symmetric KMS key to update. To get the ID of a symmetric KMS key use a list request. The maximum string length in characters is 50. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"status": "string",
"labels": "object",
"defaultAlgorithm": "string",
"rotationPeriod": "string",
"deletionProtection": true
}
Field | Description |
---|---|
updateMask | string Required. Field mask that specifies which attributes of the symmetric KMS key are going to be updated. A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in If |
name | string New name for the symmetric KMS key. The maximum string length in characters is 100. |
description | string New description for the symmetric KMS key. The maximum string length in characters is 1024. |
status | string New status for the symmetric KMS key. Using the update method you can only set ACTIVE or INACTIVE status. |
labels | object Custom labels for the symmetric KMS key as No more than 64 per resource. The maximum string length in characters for each key is 63. Each key must match the regular expression |
defaultAlgorithm | string Default encryption algorithm to be used with new versions of the symmetric KMS key. Supported symmetric encryption algorithms.
|
rotationPeriod | string Time period between automatic symmetric KMS key rotations. |
deletionProtection | boolean (boolean) Flag that inhibits deletion of the symmetric KMS key |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// 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 | string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
createdBy | string ID of the user or service account who initiated the operation. |
modifiedAt | string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
metadata | object 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 | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response 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. |