Метод list

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

Возвращает список симметричных ключей KMS в указанном каталоге.

HTTP-запрос

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

Query-параметры

Параметр	Описание
folderId	Обязательное поле. Идентификатор каталога для получения списка симметричных ключей KMS. Максимальная длина строки в символах — 50.
pageSize	Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
pageToken	Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "keys": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "status": "string",
      "primaryVersion": {
        "id": "string",
        "keyId": "string",
        "status": "string",
        "algorithm": "string",
        "createdAt": "string",
        "primary": true,
        "destroyAt": "string"
      },
      "defaultAlgorithm": "string",
      "rotatedAt": "string",
      "rotationPeriod": "string"
    }
  ],
  "nextPageToken": "string"
}

Поле	Описание
keys[]	object Симметричный ключ KMS, который может содержать несколько версий криптографического материала.
keys[]. id	string Идентификатор ключа.
keys[]. folderId	string Идентификатор каталога, которому принадлежит ключ.
keys[]. createdAt	string (date-time) Время создания ключа. Строка в формате RFC3339.
keys[]. name	string Имя симметричного ключа.
keys[]. description	string Описание симметричного ключа.
keys[]. labels	object Пользовательские метки для ключа в виде пар `key:value`. Максимум 64 на ключ.
keys[]. status	string Текущий статус ключа. CREATING: Ключ создается. ACTIVE: Ключ активен и может использоваться для шифрования и дешифрования. Можно установить в INACTIVE с помощью метода update. INACTIVE: Ключ неактивен и не может быть использован. Можно установить в ACTIVE с помощью метода update.
keys[]. primaryVersion	object Основная версия ключа, используемая по умолчанию для всех операций шифрования, когда идентификатор версии не указан явно. Версия симметричного ключа KMS: метаданные криптографического материала.
keys[]. primaryVersion. id	string Идентификатор версии ключа.
keys[]. primaryVersion. keyId	string Идентификатор симметричного ключа KMS, которому принадлежит версия.
keys[]. primaryVersion. status	string Состояние версии ключа. Возможные статусы версии. ACTIVE: Версия активна и может использоваться для шифрования и дешифрования. SCHEDULED_FOR_DESTRUCTION: Версия запланирована к уничтожению, время, когда она будет уничтожена, указано в поле `destroyAt`. DESTROYED: Версия уничтожена и не может быть восстановлена.
keys[]. primaryVersion. algorithm	string Алгоритм шифрования, который следует использовать при использовании этой версии ключа для шифрования. Поддерживаемые алгоритмы симметричного шифрования. AES_128: Алгоритм AES со 128-битными ключами. AES_192: Алгоритм AES с 192-битными ключами. AES_256: Алгоритм AES с 256-битными ключами.
keys[]. primaryVersion. createdAt	string (date-time) Время создания версии ключа. Строка в формате RFC3339.
keys[]. primaryVersion. primary	boolean (boolean) Признак основной версии, которая должна использоваться по умолчанию для всех криптографических операций, для которых явно не указана версия ключа.
keys[]. primaryVersion. destroyAt	string (date-time) Время, когда версия ключа будет уничтожена. Пустой, если статус не `SCHEDULED_FOR_DESTRUCTION`. Строка в формате RFC3339.
keys[]. defaultAlgorithm	string Алгоритм шифрования по умолчанию, который следует использовать с новыми версиями ключа. Поддерживаемые алгоритмы симметричного шифрования. AES_128: Алгоритм AES со 128-битными ключами. AES_192: Алгоритм AES с 192-битными ключами. AES_256: Алгоритм AES с 256-битными ключами.
keys[]. rotatedAt	string (date-time) Время последней ротации ключа (время, когда была создана последняя версия). Пустое, если у ключа еще нет версий. Строка в формате RFC3339.
keys[]. rotationPeriod	string Период времени между автоматическими ротациями ключа.
nextPageToken	string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.