Edge for Private Cloud v. 4.16.09
Use o utilitário apigee-adminapi.sh para realizar as mesmas tarefas de configuração do Edge que você realiza fazendo chamadas para a API de gerenciamento do Edge. A vantagem do utilitário apigee-adminapi.sh é que ele:
- Usar uma interface simples de linha de comando
- Implementa o preenchimento de comando com tabulação
- Oferece ajuda e informações de uso
- Pode mostrar a chamada de API correspondente se você decidir testar a API.
O utilitário apigee-adminapi.sh não substitui o utilitário apigee-provision. O utilitário apigee-provision usa o utilitário apigee-adminapi.sh 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 uma organização, um ambiente e um host virtual, são necessários três comandos apigee-adminapi.sh separados, correspondentes a três chamadas de API.
- O utilitário apigee-provision foi projetado para executar uma operação completa de alto nível com um único comando. Por exemplo, é possível criar uma organização, um ambiente e um host virtual com um único comando apigee-provision, transmitindo um arquivo de configuração com todas as informações necessárias.
A documentação do Edge usa os dois utilitários quando apropriado.
Instalar 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 apigee-adminapi.sh
O utilitário apigee-adminapi.sh usa uma sintaxe simples de linha de comando. A qualquer momento, use a tecla Tab para mostrar um prompt que lista as opções de comando disponíveis.
Para conferir todos os comandos possíveis, invoque o utilitário sem opções:
> apigee-adminapi.sh
Se você pressionar a tecla Tab depois de digitar apigee-adminapi.sh, vai aparecer a lista de opções possíveis:
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ê pressionar 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 exibir a ajuda de qualquer comando. Por exemplo, se você usar a opção -h, conforme mostrado abaixo:
> apigee-adminapi.sh orgs -h
O utilitário mostra informações de ajuda completas para todas as opções possíveis do comando orgs. O primeiro item na saída mostra a ajuda para o comando "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
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 opções de linha de comando ou variáveis de ambiente. Adicione um traço (-) ou dois traços (--) como prefixo da linha de comando, conforme necessário.
Por exemplo, na ajuda exibida acima para o comando "orgs add", você pode especificar o nome da organização:
- Usando a chave de linha de comando -o:
> apigee-adminapi.sh orgs -o testOrg - Definir uma variável de ambiente com o nome ORG:
> export ORG=testOrg
> apigee-adminapi.sh orgs
Se você omitir parâmetros obrigatórios do comando, o utilitário vai mostrar uma mensagem de erro descrevendo os parâmetros ausentes. Por exemplo, se você omitir a variável de ambiente --host ou EDGE_SERVER que especifica o servidor de gerenciamento do Edge ao criar uma organização, a seguinte mensagem de erro vai aparecer:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
Dois parâmetros comuns que você geralmente define como variáveis de ambiente são o endereço de 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
Transmitir um arquivo para o utilitário apigee-adminapi.sh
Alguns comandos de utilitário apigee-adminapi.sh correspondem a chamadas de API PUT e POST que usam um corpo de solicitação. Por exemplo, a criação de um host virtual corresponde a uma chamada de API POST que exige informações sobre o host virtual no corpo da solicitação.
Ao usar o utilitário apigee-adminapi.sh para criar um host virtual ou qualquer comando que use um corpo de solicitação, é possível transmitir todas as 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
Ou você pode passar um arquivo contendo as mesmas informações que seriam contidas no corpo da solicitação do 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>
Como mostrar informações de depuração e da API
Use a opção --debug para o utilitário apigee-adminapi.sh para mostrar informações detalhadas sobre o comando. Essas informações incluem o comando cURL gerado 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