Skip to content

Управление профилем

Профили используются для разделения операций для разных сервисных аккаунтов. Кроме того, каждый профиль можно кастомизировать, установив для него индивидуальные параметры профиля. После инициализации первого профиля вы можете создать новый профиль или управлять существующим.

Просмотреть информацию о профиле

bash
mws profile get <имя профиля>

Пример результата:

bash
+------------------+------------+-----------------+
|       NAME       |  SUBJECT   | DEFAULT PROJECT |
+------------------+------------+-----------------+
| default (ACTIVE) | my-account | my-project      |
+------------------+------------+-----------------+

Чтобы получить подробную информацию о профиле:

bash
mws profile get <имя профиля> --full
Пример результата
bash
base_endpoint: https://api.mwsapis.ru
project: <имя проекта>
zone: "<зона доступности>"
subject:
    name: <имя сервисного аккаунта>
    authorized_key:
        id: <имя ключа сервисного аккаунта>
        algorithm: ES256
client_timeout: 5s
log_level: info
trace_enabled: false

Совет

Чтобы получить вывод команды в удобном для вас формате, используйте флаг --format. Доступные значения — json, yaml или text.

Добавить профиль

Примечание

Если не указать другое имя профиля (--profile), будут перезаписаны настройки профиля default.

  1. (опционально) Создайте новый сервисный аккаунт и создайте для него авторизованный ключ, если новый профиль будет иметь другие права доступа.

  2. Создайте новый профиль:

    bash
    mws init --profile <имя профиля> --service-account-authorized-key <путь к файлу с авторизованным ключом, включая расширение>

    При успешном выполнении команды появится сообщение вида:

    bash
    Profile "<имя профиля>" successfully initialized at "/<домашний каталог пользователя>/.mws/config/<имя профиля>.yaml"
  3. (опционально) Выполните запрос к MWS API, например, запросив список типов ВМ:

    bash
    mws compute vm-type list
    Пример результата
    bash
    +--------------------+-------------+--------+-------------+
    |       ID           | DESCRIPTION | STATUS | UPDATE TIME |
    +--------------------+-------------+--------+-------------+
    | vmTypes/gen-16-128 |             | OK     |             |
    +--------------------+-------------+--------+-------------+
    | vmTypes/gen-16-32  |             | OK     |             |
    +--------------------+-------------+--------+-------------+
    | vmTypes/gen-16-64  |             | OK     |             |
    +--------------------+-------------+--------+-------------+
    | vmTypes/gen-2-16   |             | OK     |             |
    +--------------------+-------------+--------+-------------+
    | vmTypes/gen-2-4    |             | OK     |             |
    +--------------------+-------------+--------+-------------+
    | vmTypes/gen-2-8    |             | OK     |             |
    +--------------------+-------------+--------+-------------+

Вывести список профилей

bash
mws profile list
Пример результата
bash
+------------------+-----------------+-----------------+
|       NAME       |     SUBJECT     | DEFAULT PROJECT |
+------------------+-----------------+-----------------+
| default (ACTIVE) | <имя аккаунта>  | <имя проекта>   |
+------------------+-----------------+-----------------+
| <имя профиля>    | <имя аккаунта>  | <имя проекта>   |
+------------------+-----------------+-----------------+

Чтобы вывести дополнительную информацию о профилях (публичный ключ и зону по умолчанию), выполните команду:

bash
mws profile list --full
Пример результата
bash
+------------------+----------------+------------------------------------------+-----------------+--------------+
|       NAME       |     SUBJECT    |                PUBLIC KEY                | DEFAULT PROJECT | DEFAULT ZONE |
+------------------+----------------+------------------------------------------+-----------------+--------------+
| default (ACTIVE) | <имя аккаунта> | MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEQwig | <имя проекта>   | <имя зоны>   |
|                  |                | Z14OM6IrYT111n78IJmzt3BCeg6MIE/JzpF2dlU5 |                 |              |
|                  |                | n0USl4t/PNbRaSsp07BU...                  |                 |              |
+------------------+----------------+------------------------------------------+-----------------+--------------+
| <имя профиля>    | <имя аккаунта> | MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE0qfD | <имя проекта>   | <имя зоны>   |
|                  |                | 92NW1wDd6NKkfffNUVZMjOd7zk1/vxPaOHuslkfW |                 |              |
|                  |                | W0fSmcNBI0YIUjHaODY3...                  |                 |              |
+------------------+----------------+------------------------------------------+-----------------+--------------+

Совет

Чтобы получить вывод команды в удобном для вас формате, используйте флаг --format. Доступные значения — json, yaml или text.

Вывести активный профиль

bash
mws profile current

Примечание

Активный профиль также отображается в общей таблице профилей с пометкой (ACTIVE).

Переключиться на другой профиль

Если вы хотите изменить активный профиль, вы можете переключить его с помощью команды:

bash
mws profile activate <имя профиля>

При успешном выполнении команды появится сообщение:

bash
Current profile successfully set to "<имя профиля>"

Совет

Вы также можете выполнять запросы под нужным профилем с помощью глобального флага --profile <имя профиля>.

Изменить параметры профиля

Вы можете изменить следующие значения параметров профиля:

ПараметрОписание
projectПроект MWS для профиля, используемый по умолчанию. Применяется для всех команд
zoneЗона доступности для профиля, используемая по умолчанию. Применяется для зональных ресурсов, например, ВМ
base_endpointЭндпоинт, на который MWS CLI будет отправлять запросы
client_timeoutТаймаут выполнения запроса. Значение по умолчанию — 5 секунд
log_levelУровень логирования.
Возможные значения: debug, info, warn, error, fatal, значение по умолчанию — info
trace_enabledТрассировка запроса.
Возможные значения: true или false, значение по умолчанию — false

Посмотреть список параметров профиля

bash
mws profile param list

Посмотреть значение параметра профиля

bash
mws profile param get <параметр профиля>

Установить значение параметра профиля

bash
mws profile param set <параметр профиля> <значение>

Очистить значение параметра профиля

bash
mws profile param clear <параметр профиля>

Удалить профиль

Важно

При удалении профиля все его настройки будут удалены.

bash
mws profile delete <имя профиля>

При успешном выполнении команды появится сообщение:

bash
Profile "<имя профиля>" successfully deleted.