Как использовать утилиту apigee-adminapi.sh

apigee-adminapi.sh вызывает API управления Edge для выполнения различных задач по обслуживанию.

О скрипте apigee-adminapi.sh

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Вызов apigee-adminapi.sh

Вы вызываете apigee-adminapi.sh из узла сервера управления. При вызове утилиты необходимо определить следующие переменные среды или параметры командной строки:

• ADMIN_EMAIL (соответствует параметру командной строки admin)
• ADMIN_PASSWORD (pwd)
• EDGE_SERVER (host)

В следующем примере вызывается apigee-adminapi.sh и передаются необходимые значения в виде параметров командной строки:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh buildinfo list --admin user@example.com --pwd abcd1234 --host localhost

В следующем примере необходимые параметры определяются как временные переменные среды, а затем вызывается утилита apigee-adminapi.sh:

export ADMIN_EMAIL=user@example.com
export ADMIN_PASSWORD=abcd1234
export EDGE_SERVER=192.168.56.101
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh servers list

Если вы не передадите пароль в качестве параметра или не зададите его как переменную среды, apigee-adminapi.sh предложит вам ввести его.

Как задать параметры apigee-adminapi.sh

Все параметры команды необходимо указать с помощью переключателей командной строки или переменных среды. Перед переключателями командной строки нужно поставить один дефис (-) или два дефиса (--), как требуется.

Например, название организации можно указать одним из следующих способов:

• С помощью переключателя командной строки -o:

  /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg

• Установка переменной среды с именем ORG:

  export ORG=testOrg
  /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Если вы не укажете в команде обязательные параметры, утилита покажет сообщение об ошибке с описанием отсутствующих параметров. Например, если вы не укажете параметр --host (соответствующий переменной среды EDGE_SERVER), apigee-adminapi.sh вернет следующую ошибку:

Error with required variable or parameter
ADMIN_PASSWORD....OK
ADMIN_EMAIL....OK
EDGE_SERVER....null

Если вы получили ошибку HTTP STATUS CODE: 401, значит ввели неверный пароль.

Как получить справку по apigee-adminapi.sh

В любой момент можно нажать клавишу Tab, чтобы посмотреть список доступных команд.

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

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

Если после ввода apigee-adminapi.sh нажать клавишу Tab, появится список возможных вариантов:

analytics  classification  logsessions  regions  securityprofile  userroles
buildinfo  GET             orgs         runtime  servers          users

Клавиша Tab показывает варианты в зависимости от контекста команды. Если после ввода текста нажать клавишу Tab:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Вы увидите возможные варианты завершения команды orgs:

add  apis  apps  delete  envs  list  pods  userroles

Чтобы получить справку по любой команде, используйте параметр -h. Например, если вы используете параметр -h, как показано ниже:

/opt/apigee/apigee-adminapi/bin/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

Как передать файл в apigee-adminapi.sh

Утилита apigee-adminapi.sh – это оболочка для curl. В результате некоторые команды соответствуют вызовам API PUT и POST, которые принимают тело запроса. Например, создание виртуального хоста соответствует вызову API POST, который требует указания информации о виртуальном хосте в теле запроса.

При использовании утилиты apigee-adminapi.sh для создания виртуального хоста или любой команды, которая принимает тело запроса, вы можете передать всю необходимую информацию в командной строке, как показано ниже:

/opt/apigee/apigee-adminapi/bin/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. Например, следующая команда принимает файл, определяющий виртуальный хост:

/opt/apigee/apigee-adminapi/bin/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. Результаты показывают выходные данные команды curl в подробном режиме:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
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