Spec-Zone.ru › AWS CLI v2

[ aws . lightsail ]

получить-пару-ключей

Описание

Возвращает информацию о конкретной паре ключей.

См. также: Документацию API AWS

Синтаксис

  get-key-pair
--key-pair-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--key-pair-name (строка)

Имя пары ключей, о которой запрашивается информация.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, заданному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, заданные в JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, выводит пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, выполняет валидацию входных данных команды и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости для сгенерированного JSON-скелета.

Глобальные параметры

--debug (булево)

Включает отладку.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию, связанное с проверкой сертификатов SSL.

--no-paginate (булево)

Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображает версию этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет интерпретироваться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить страницу cli для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров входных данных CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в Руководстве пользователя AWS CLI.

Для получения информации о паре ключей

Следующий get-key-pair пример отображает подробности о заданной паре ключей.

aws lightsail get-key-pair \
    --key-pair-name MyKey1

Вывод:

{
    "keyPair": {
        "name": "MyKey1",
        "arn": "arn:aws:lightsail:us-west-2:111122223333:KeyPair/19a4efdf-3054-43d6-91fd-eEXAMPLE21bf",
        "supportCode": "6EXAMPLE3362/MyKey1",
        "createdAt": 1571255026.975,
        "location": {
            "availabilityZone": "all",
            "regionName": "us-west-2"
        },
        "resourceType": "KeyPair",
        "tags": [],
        "fingerprint": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:gg:hh:ii:jj"
    }
}

Вывод

ключеваяПара -> (структура)

Массив пар ключ-значение, содержащих информацию о паре ключей.

имя -> (строка)

Дружественное имя пары SSH-ключей.

arn -> (строка)

Amazon Resource Name (ARN) пары ключей (arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

кодПоддержки -> (строка)

Код поддержки. Включите этот код в ваше письмо в службу поддержки, когда у вас есть вопросы об экземпляре или другом ресурсе в Lightsail. Этот код позволяет нашей команде поддержки легче найти вашу информацию о Lightsail.

датаСоздание -> (временная метка)

Временная метка создания пары ключей (1479816991.349).

местоположение -> (структура)

Имя региона и зона доступности, в которых была создана пара ключей.

зонаДоступности -> (строка)

Зона доступности. Соответствует формату us-east-2a (регистрозависимый).

имяРегиона -> (строка)

Название региона Amazon Web Services.

типРесурса -> (строка)

Тип ресурса (обычно KeyPair).

теги -> (список)

Ключи тегов и необязательные значения для ресурса. Дополнительную информацию о тегах в Lightsail см. в руководстве разработчика Amazon Lightsail .

(структура)

Описывает ключ тега и необязательное значение, назначенные ресурсу Amazon Lightsail.

Для получения дополнительной информации о тегах в Lightsail, см. руководство разработчика Amazon Lightsail .

ключ -> (строка)

Ключ тега.

Ограничения: Ключи тегов принимают максимум 128 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

значение -> (строка)

Значение тега.

Ограничения: Значения тегов принимают максимум 256 символов, цифр, пробелов в UTF-8 или следующих символов: + - = . _ : / @

отпечаток -> (строка)

Отпечаток RSA пары ключей.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API