Метод create

HTTP-запрос
Параметры в теле запроса
Ответ

Создает симметричный ключ KMS в указанном каталоге.

HTTP-запрос

POST https://kms.api.cloud.yandex.net/kms/v1/keys

Параметры в теле запроса

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "defaultAlgorithm": "string",
  "rotationPeriod": "string"
}

Поле	Описание
folderId	string Обязательное поле. Идентификатор каталога, в котором создается симметричный ключ KMS. Максимальная длина строки в символах — 50.
name	string Имя симметричного ключа. Максимальная длина строки в символах — 100.
description	string Описание симметричного ключа. Максимальная длина строки в символах — 1024.
labels	object Пользовательские метки для ключа в виде пар `key:value`. Максимум 64 на ключ. Например, @b "" project": "mvp" `или @b "" source": "dictionary"`. Не более 64 на ресурс. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению `[a-z][-_0-9a-z]`. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению `[-_0-9a-z]`.
defaultAlgorithm	string Алгоритм шифрования, который будет использоваться с версией ключа, которая будет сгенерирована при следующей ротации. Поддерживаемые алгоритмы симметричного шифрования. AES_128: Алгоритм AES со 128-битными ключами. AES_192: Алгоритм AES с 192-битными ключами. AES_256: Алгоритм AES с 256-битными ключами.
rotationPeriod	string Интервал между автоматическими ротациями. Чтобы отключить автоматическую ротацию, не включайте это поле в запрос на создание.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.

Поле	Описание
id	string Идентификатор операции.
description	string Описание операции. Длина описания должна быть от 0 до 256 символов.
createdAt	string (date-time) Время создания ресурса в формате в RFC3339. Строка в формате RFC3339.
createdBy	string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modifiedAt	string (date-time) Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. Строка в формате RFC3339.
done	boolean (boolean) Если значение равно `false` — операция еще выполняется. Если `true` — операция завершена, и задано значение одного из полей `error` или `response`.
metadata	object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля `metadata`.
error	object Описание ошибки в случае сбоя или отмены операции. включает только одно из полей `error`, `response` Описание ошибки в случае сбоя или отмены операции.
error. code	integer (int32) Код ошибки. Значение из списка google.rpc.Code.
error. message	string Текст ошибки.
error. details[]	object Список сообщений с подробными сведениями об ошибке.
response	object включает только одно из полей `error`, `response` Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля `response`.