Edge for Private Cloud v. 4.16.09
Утилита apigee-adminapi.sh позволяет выполнять те же задачи по настройке Edge, что и вызовы Edge Management API. Преимущество утилиты apigee-adminapi.sh заключается в том, что она:
- Используйте простой интерфейс командной строки.
- Реализует автозавершение команд с помощью клавиши Tab.
- Предоставляет справочную информацию и сведения об использовании.
- Показывает соответствующий вызов API, если вы решите попробовать API.
Утилита apigee-adminapi.sh не заменяет утилиту apigee-provision. Для выполнения задач утилита apigee-provision использует утилиту apigee-adminapi.sh.
Основные различия между ними:
- Утилита apigee-adminapi.sh выполняет атомарные функции, которые заменяют отдельные вызовы Edge API. Например, чтобы создать организацию, среду и виртуальный хост, требуется три отдельных команды apigee-adminapi.sh, соответствующих трем вызовам API.
- Утилита apigee-provision предназначена для выполнения полной высокоуровневой операции с помощью одной команды. Например, вы можете создать организацию, среду и виртуальный хост с помощью одной команды apigee-provision, передав файл конфигурации со всей необходимой информацией.
В документации Edge используются обе утилиты, где это уместно.
Установка apigee-adminapi.sh
Утилита apigee-adminapi.sh устанавливается автоматически при установке утилиты apigee-provision или apigee-validate.
Утилита устанавливается в следующую папку:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
Синтаксис apigee-adminapi.sh
Утилита apigee-adminapi.sh использует простой синтаксис командной строки. Чтобы посмотреть список доступных параметров команды, нажмите клавишу Tab.
Чтобы посмотреть все возможные команды, запустите утилиту без параметров:
> apigee-adminapi.sh
Если вы нажмете клавишу Tab после ввода apigee-adminapi.sh, вы увидите список возможных вариантов:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
При нажатии клавиши Tab показываются варианты, соответствующие контексту команды. Если после ввода текста нажать клавишу Tab:
> apigee-adminapi.sh orgs
Вы увидите возможные варианты завершения команды orgs:
add apis apps delete envs list pods userroles
Чтобы посмотреть справку по любой команде, используйте параметр -h. Например, если вы используете параметр -h, как показано ниже:
> apigee-adminapi.sh orgs -h
Утилита покажет полную справочную информацию обо всех возможных параметрах команды orgs. Первый элемент в выходных данных – это справка по команде orgs add:
+++++++++++++++++++++++++++++++++++++++++++ orgs add Required: -o ORG Organization name Optional: -H HEADER add http header in request --admin ADMIN_EMAIL admin email address --pwd ADMIN_PASSWORD admin password --host EDGE_SERVER edge server to make request to --port EDGE_PORT port to use for the http request --ssl set EDGE_PROTO to https, defaults to http --debug ( set in debug mode, turns on verbose in curl ) -h Displays Help
Настройка параметров с помощью переключателей командной строки и переменных среды
Все параметры команды необходимо вводить с помощью переключателей командной строки или переменных среды. Перед переключателями командной строки нужно ставить один (-) или два (--) дефиса.
Например, в приведенной выше справке по команде "orgs add" указать название организации можно двумя способами:
- С помощью переключателя командной строки -o:
> apigee-adminapi.sh orgs -o testOrg - Задание переменной среды с именем ORG:
> export ORG=testOrg
> apigee-adminapi.sh orgs
Если вы пропустите какие-либо обязательные параметры команды, утилита покажет сообщение об ошибке с описанием отсутствующих параметров. Например, если при создании организации вы не укажете переменную среды --host или EDGE_SERVER, определяющую сервер управления Edge, появится следующее сообщение об ошибке:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
Два распространенных параметра, которые вы часто устанавливаете в качестве переменных среды, – это адрес электронной почты системного администратора и IP-адрес сервера управления:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
Передача файла в утилиту apigee-adminapi.sh
Некоторые команды утилиты apigee-adminapi.sh соответствуют вызовам API PUT и POST, которые принимают тело запроса. Например, создание виртуального хоста соответствует вызову API POST, который требует информацию о виртуальном хосте в теле запроса.
При использовании утилиты apigee-adminapi.sh для создания виртуального хоста или любой команды, которая принимает тело запроса, вы можете передать всю необходимую информацию в командной строке, как показано ниже:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005
Вы также можете передать файл, содержащий ту же информацию, что и тело запроса POST. Например, следующая команда принимает файл, определяющий виртуальный хост:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
где файл vhostcreate содержит тело POST вызова. В этом примере тело запроса имеет формат XML:
<VirtualHost name="myVHostUtil">
<HostAliases>
<HostAlias>192.168.56.101:9005</HostAlias>
</HostAliases>
<Interfaces/>
<Port>9005</Port>
</VirtualHost>Как посмотреть информацию об отладке и API
Используйте параметр --debug для утилиты apigee-adminapi.sh, чтобы отобразить подробную информацию о команде. В частности, вы увидите команду cURL, сгенерированную утилитой apigee-adminapi.sh для выполнения операции.
Например, в этой команде используется параметр --debug:
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
и отображает следующие выходные данные, включая сгенерированную команду cURL:
curl -H Content-Type: application/xml -v -X POST -s -k -w \n==> %{http_code} -u ***oo@bar.com:***** http://localhost:8080/v1/o -d <Organization name="testOrg2" type="paid"/> * About to connect() to localhost port 8080 (#0) * Trying ::1... connected * Connected to localhost (::1) port 8080 (#0) * Server auth using Basic with user 'foo@bar.com' > POST /v1/o HTTP/1.1 > Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5 > User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1 Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2 > Host: localhost:8080 > Accept: */* > Content-Type: application/xml > Content-Length: 43 > } [data not shown] < HTTP/1.1 201 Created < Content-Type: application/json < Date: Tue, 03 May 2016 02:08:32 GMT < Content-Length: 291 < { [data not shown] * Connection #0 to host localhost left intact * Closing connection #0