Edge for Private Cloud v. 4.16.05
Use o comando apigee-adminapi.sh execute as mesmas tarefas de configuração do Edge ao fazer chamadas para ele API de gerenciamento. A vantagem do utilitário apigee-adminapi.sh é que ele:
- Usar uma interface de linha de comando simples
- Implementa o preenchimento de comando baseado em guias
- Fornece informações de ajuda e uso
- Pode exibir a chamada de API correspondente se você decidir testar a API
O utilitário apigee-adminapi.sh não é uma substituição do utilitário apigee-provision. O utilitário apigee-provision usa a apigee-adminapi.sh para para realizar as tarefas.
As principais diferenças entre os dois são:
- O utilitário apigee-adminapi.sh executa funções atômicas que substituem chamadas individuais da API Edge. Por exemplo, para criar um organização, ambiente e host virtual exigem três comandos apigee-adminapi.sh separados que correspondem a três chamadas de API.
- O apigee-provision foi projetado para executar uma operação completa de alto nível com um único comando. Para Por exemplo, é possível criar uma organização, um ambiente e um host virtual com uma única o comando apigee-provision por passando um arquivo de configuração com todas as informações necessárias.
A documentação do Edge usa os dois utilitários quando apropriado.
Como instalar o apigee-adminapi.sh
O utilitário apigee-adminapi.sh é instalado automaticamente quando você instala o utilitário apigee-provision ou apigee-validate.
O utilitário é instalado no seguinte local:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
Sintaxe de apigee-adminapi.sh
O utilitário apigee-adminapi.sh usa uma sintaxe de linha de comando simples. A qualquer momento, use a tecla Tab para exibir uma solicitação que lista as opções de comando disponíveis.
Para ver todos os comandos possíveis, invoque o utilitário sem opções:
> apigee-adminapi.sh
Se pressionar a tecla Tab após digitar apigee-adminapi.sh, você verá a lista de possíveis opções:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
A tecla Tab mostra opções com base no contexto do comando. Se você inserir a tecla Tab depois de digitar:
> apigee-adminapi.sh orgs
Você verá as opções possíveis para concluir o comando orgs:
add apis apps delete envs list pods userroles
Use a opção -h para mostrar ajuda para qualquer comando. Por exemplo, se você usar a opção -h como mostrado abaixo:
> apigee-adminapi.sh orgs -h
O utilitário exibe informações de ajuda completas para todas as opções possíveis do comando orgs. O primeiro item na saída mostra a ajuda do campo "Adicionar organizações" comando:
+++++++++++++++++++++++++++++++++++++++++++ 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
Como definir parâmetros usando chaves de linha de comando e variáveis de ambiente
É necessário inserir todos os parâmetros em um comando usando chaves de linha de comando ou variáveis de ambiente. Adicione um único travessão (-) ou traço duplo antes das chaves de linha de comando. (--) conforme necessário.
Por exemplo, na ajuda mostrada acima para "adicionar organizações" é possível especificar nome da organização:
- Como usar a linha de comando -o
interruptor:
> apigee-adminapi.sh orgs -o testOrg - Configure uma variável de ambiente chamada ORG:
> exportar ORG=testOrg
> apigee-adminapi.sh orgs
Se você omitir algum parâmetro obrigatório para o comando, o utilitário exibirá uma mensagem de erro. que descrevem os parâmetros ausentes. Por exemplo, se você omitir a variável de ambiente --host ou EDGE_SERVER especificando o Edge Management Server ao criar uma organização, você verá a seguinte mensagem de erro:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
Dois parâmetros comuns que costumam ser definidos como variáveis de ambiente são o e-mail do administrador do sys e o endereço IP do servidor de gerenciamento:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
Como transmitir um arquivo para apigee-adminapi.sh utilitário
Alguns comandos do utilitário apigee-adminapi.sh correspondem a chamadas de API PUT e POST que usam o corpo de uma solicitação. Por exemplo, criar uma VM host corresponde a uma chamada de API POST que requer informações sobre o host virtual no corpo da solicitação.
Quando você usa o utilitário apigee-adminapi.sh para criar um host virtual ou qualquer comando que use um corpo de solicitação, será possível transmitir informações necessárias na linha de comando, conforme mostrado abaixo:
> 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
Se preferir, você pode transmitir um arquivo que contenha as mesmas informações contidas na solicitação corpo de POST. Por exemplo, o comando a seguir usa um arquivo que define o host virtual:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
em que o arquivo vhostcreate contém o corpo POST da chamada. Neste exemplo, é um corpo de solicitação formatado em XML:
<VirtualHost name="myVHostUtil">
<HostAliases>
<HostAlias>192.168.56.101:9005</HostAlias>
</HostAliases>
<Interfaces/>
<Port>9005</Port>
</VirtualHost>
Exibição de informações de depuração e API
Use a opção --debug para o utilitário apigee-adminapi.sh para exibe informações detalhadas sobre o comando. Essas informações incluem o comando cURL, gerados pelo utilitário apigee-adminapi.sh para realizar a operação.
Por exemplo, este comando usa a opção --debug:
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
E exibe a seguinte saída, incluindo o comando cURL gerado:
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