Концепции

В этом разделе описаны основные концепции, необходимые для понимания работы инструмента Cloud CLI.

Команды

Команды — инструкции по эксплуатации, предоставляемые Cloud CLI для настройки рабочей среды или вызова открытых API облачных служб.

Формат команды для вызова API:

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

Формат системной команды:

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

Operation

Operation — уникальное название API облачных сервисов, описанное в API Explorer. Весь список доступных операций можно запросить с помощью API Explorer или выполнив команду cloud <service> --help.

Профиль

Профили Cloud CLI хранят информацию, необходимую для вызова API облачных сервисов: ключи доступа (AK/SK), регион (cli-region), ID проекта (cli-project ID) и ID домена (cli-domain-ID).

Профили представляют собой файл конфигурации, который хранится на вашем локальном хосте. Они позволяют при вызове API облачных сервисов не вводить сохраненную в них информацию, а только указать сам профиль.

Профиль по умолчанию

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

В качестве профиля по умолчанию Cloud CLI использует последний добавленный или измененный пользователем профиль.

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

Для изменения профиля по умолчанию можно запустить команду:

cloud configure set --cli-profile=${profileName}

Параметр

Параметры могут быть системными или API-параметрами.

Параметры API — это заданные параметры в API облачных сервисов.
Системные параметры — это встроенные параметры Cloud CLI. Эти параметры фиксированы и имеют установленные характеристики.

Опции

Опции — системные параметры Cloud CLI, которые можно добавлять в команды для вызова API. Не все системные параметры можно использовать в качестве опций.

Метаданные

Метаданные — сведения об облачных сервисах и их API, которые Cloud CLI получает во время выполнения команды для проверки и анализа параметров.

Полученные метаданные хранятся локально для сокращения сетевого ввода-вывода и ускорения ответа на команды. Файл, в котором хранятся метаданные, называется файлом кэша метаданных.