nav-img
Advanced

Быстрый старт

В этом разделе описано, как установить Cloud CLI, инициализировать профиль и получить информацию о виртуальных машинах ECS с помощью командной строки.

Перед началом работы

  1. Создайте IAM-пользователя на платформе Advanced и предоставьте ему разрешения для управления нужными облачными сервисами.

  2. Войдите в систему как IAM-пользователь.

  3. Создайте ключи доступа AK/SK.

Установка Cloud CLI

Установите Cloud CLI для одной из операционных систем:

Внимание

При первом использовании интерфейса командной строки Cloud (Cloud CLI) подтвердите подключение к интернету и примите Политику конфиденциальности Cloud.ru.

Принять политику конфиденциальности можно с помощью команды:

cloud configure set --cli-agree-privacy-statement=true

Инициализация

Инициализация нужна для того, чтобы сохранить в конфигурационном файле информацию о ключах AK/SK и регионе и не вводить ее повторно при каждом подключении.

В этой инструкции приведен пример для операционной системы Windows. Для ОС Linux и macOS процедура выполняется похожим образом.

Параметры инициализации:

  • Access Key ID (AK) — ID ключа доступа, находится в файле credentials.csv.

  • Secret Access Key (SK) — секретный ключ доступа, находится в файле credentials.csv.

  • Region — регион, по умолчанию «ru-moscow-1».

Для выполнения инициализации:

  1. Введите команду:

    cloud configure init
  2. Нажмите Enter.

    Откроется диалоговый режим. Установите в нем соответствующие параметры, как показано в примере:

    Starting initialization. 'Secret Access Key' is anonymized. To obtain the parameter, see 'https://support.hc.sbercloud.ru/en-us/usermanual/cloudcli/hcli_09.html'.
    Access Key ID [required]: H9NNF********SG65MXW
    Secret Access Key [required]: ****
    Secret Access Key (again): ****
    Region: ru-moscow-1
    ********************************************************
    ***** *****
    ***** Initialization successful *****
    ***** *****
    ********************************************************
  3. Отправьте запрос для проверки введенных данных инициализации:

    cloud configure show --cli-profile=default

Выполнение команд в Cloud CLI

После завершения инициализации можно управлять облачными сервисами с помощью команд Cloud CLI.

Подсказка

Упростить работу с Cloud CLI можно с помощью API Explorer — удобного инструмента для онлайн-отладки API и генерации примеров Cloud CLI для API облачных сервисов.

В этом примере используется API Elastic Cloud Server (ECS) для запроса сведений о виртуальных машинах ECS.

  1. Сделайте запрос всех операций облачного сервиса.

    Команда для вывода списка всех доступных операций с облачным сервисом имеет вид:

    cloud <service> --help

    Чтобы вывести все доступные операции с ECS, выполните команду:

    cloud ECS --help
  2. Запросите справочную информацию об операции.

    Общий вид команды:

    cloud <service> <operation> --help

    Чтобы вывести информацию об операции NovaShowServer, введите команду:

    cloud ECS NovaShowServer --help
  3. Введите команду для вызова API и получения результата выполнения.

    Общий вид команды:

    cloud <service> <operation> [--param1=paramValue1 --param2=paramValue2 ...]

    Где:

    • cli-region — регион;

    • project_id — идентификатор проекта;

    • server_id — идентификатор виртуальной машины ECS.

    Пример ввода команды:

    cloud ECS NovaShowServer --cli-region="ru-moscow-1" --project_id="0dd8cb****************19b5a84546" --server_id="4f06****-****-****-****-****04dd856a"
Примечание

Примеры команд Cloud CLI для вызова API можно просмотреть в API Explorer.

Cloud CLI автоматически получает идентификатор учетной записи и идентификатор проекта IAM-пользователя на основе информации об аутентификации пользователя во время вызова API. Пользователю не нужно указывать cli-region в команде, если он уже был указан в информации о конфигурации.

Если значение параметра в команде неверное, отображается сообщение об ошибке:

cloud ECS ShowServer --project_id="0dd8cb****************19b5a84546" --cli-region="ru-moscow-1" --server_id="abc"
{
"error": {
"message": "Instance[abc] could not be found.",
"code": "Ecs.0114"
}
}
For details, go to the API Error Center at 'https://console.hc.sbercloud.ru/apiexplorer/#/errorcenter?keyword=Ecs.0114&product=ECS'.