Esta página foi traduzida pela API Cloud Translation.

Como usar o utilitário apigee-adminapi.sh

Edge para nuvem privada v4.18.05

Usar o utilitário apigee-adminapi.sh para executar as mesmas tarefas de configuração do Edge que você executa fazendo chamadas à API Edge Management. A vantagem da O utilitário apigee-adminapi.sh é que:

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 substitui o Utilitário apigee-provision. O utilitário apigee-provision usa utilitário apigee-adminapi.sh para executar 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 host requer três comandos apigee-adminapi.sh separados, correspondendo a três chamadas de API.
O utilitário apigee-provision foi projetado para realizar uma análise de dados em um só comando. Por exemplo, é possível criar uma organização, um ambiente e host virtual com um único comando apigee-provision ao transmitir 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 apigee-provision ou o utilitário apigee-validate.

O utilitário é instalado no seguinte local:

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

Sintaxe de /opt/apigee/apigee-adminapi/bin/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 um prompt que lista as opções de comando disponíveis.

Para ver todos os comandos possíveis, invoque o utilitário sem opções:

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

/opt/apigee/apigee-adminapi/bin/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 o método -h, como mostrado abaixo:

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

O utilitário exibe informações de ajuda completas sobre todas as opções possíveis para o 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 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.

Observação: se você omitir a senha do administrador sys ao inserir uma o utilitário apigee-adminapi.sh vai solicitar o comando. Não vai enviar uma solicitação para outros parâmetros.

Por exemplo, na ajuda mostrada acima para "adicionar organizações" é possível especificar nome da organização:

Use a chave da linha de comando -o:

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

Configure uma variável de ambiente chamada ORG:

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

Observação:em geral, são usadas variáveis de ambiente para definir ADMIN_EMAIL e EDGE_SERVER e, opcionalmente, ADMIN_PASSWORD. Esses parâmetros são usados pela maioria dos comandos. A preocupação com a configuração outros parâmetros, como ORG, ao usar variáveis de ambiente é que a configuração pode correta para um comando, mas pode estar incorreta para um comando subsequente. Para Por exemplo, se você se esquecer de redefinir a variável de ambiente, poderá passar o erro no próximo comando.

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 --host ou A variável de ambiente EDGE_SERVER que especifica o servidor de gerenciamento de borda ao criar em uma organização, 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 utilitários do 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.

Ao usar 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:

/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

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:

/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

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 a fim de exibir informações detalhadas sobre o comando. Essas informações incluem o comando curl gerado pelo o utilitário apigee-adminapi.sh para executar a operação.

Por exemplo, este comando usa a opção --debug:

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