Apigee-adminapi.sh yardımcı programını kullanma

apigee-adminapi.sh, birçok bakım görevini gerçekleştirmek için Edge Management API'yi çağırır.

apigee-adminapi.sh hakkında

apigee-adminapi.sh dosyasını çağırın.

apigee-adminapi.sh işlevini bir yönetim sunucusu düğümünden çağırıyorsunuz. Yardımcı programı çağırdığınızda aşağıdakileri ortam değişkenleri veya komut satırı seçenekleri olarak tanımlamanız gerekir:

  • ADMIN_EMAIL (admin komut satırı seçeneğine karşılık gelir)
  • ADMIN_PASSWORD (pwd)
  • EDGE_SERVER (host)

Aşağıdaki örnekte apigee-adminapi.sh çağrılır ve gerekli değerler komut satırı seçenekleri olarak iletilir:

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

Aşağıdaki örnekte, gerekli seçenekler geçici ortam değişkenleri olarak tanımlanmakta ve ardından apigee-adminapi.sh yardımcı programı çağrılmaktadır:

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

Şifreyi seçenek olarak iletmez veya ortam değişkeni olarak tanımlamazsanız apigee-adminapi.sh, şifreyi girmenizi ister.

apigee-adminapi.sh parametrelerini ayarlama

Bir komuta tüm parametreleri girmek için komut satırı anahtarlarını veya ortam değişkenlerini kullanmanız gerekir. Komut satırı anahtarlarının önüne gerektiği gibi tek tire (-) veya çift tire (--) ekleyin.

Örneğin, kuruluş adını aşağıdaki yöntemlerden biriyle belirtebilirsiniz:

  • -o komut satırı anahtarını kullanma: 
    /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg
  • ORG adlı bir ortam değişkeni ayarlama: 
    export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

Komut için gerekli parametrelerden herhangi birini atlarsanız yardımcı program, eksik parametreleri açıklayan bir hata mesajı gösterir. Örneğin, --host seçeneğini (EDGE_SERVER ortam değişkenine karşılık gelir) atlarsanız apigee-adminapi.sh aşağıdaki hatayla yanıt verir:

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

HTTP STATUS CODE: 401 hatası alırsanız yanlış şifre girmişsiniz demektir.

apigee-adminapi.sh ile ilgili yardım alma

Kullanılabilir komut seçeneklerini listeleyen bir istem görüntülemek için istediğiniz zaman Sekme tuşunu kullanın.

Olası tüm komutları görmek için yardımcı programı herhangi bir seçenek olmadan çağırın:

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

apigee-adminapi.sh yazdıktan sonra sekme tuşuna basarsanız olası seçeneklerin listesini görürsünüz:

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

Sekme tuşu, komutun bağlamına göre seçenekleri gösterir. Yazdıktan sonra sekme tuşuna basarsanız:

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

orgs komutunu tamamlamak için kullanabileceğiniz seçenekleri görürsünüz:

add  apis  apps  delete  envs  list  pods  userroles

Herhangi bir komutla ilgili yardım içeriğini görüntülemek için -h seçeneğini kullanın. Örneğin, aşağıdaki gibi -h seçeneğini kullanırsanız:

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

Yardımcı program, orgs komutunun tüm olası seçenekleri için eksiksiz yardım bilgileri gösterir. Çıkıştaki ilk öğe, orgs add komutuyla ilgili yardımı gösterir:

+++++++++++++++++++++++++++++++++++++++++++
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'ye dosya iletme

apigee-adminapi.sh yardımcı programı, curl için bir sarmalayıcıdır. Bu nedenle, bazı komutlar istek gövdesi alan PUT ve POST API çağrılarına karşılık gelir. Örneğin, sanal ana makine oluşturmak, istek gövdesinde sanal ana makine hakkında bilgi gerektiren bir POST API çağrısına karşılık gelir.

Sanal ana makine oluşturmak için apigee-adminapi.sh yardımcı programını veya istek gövdesi alan herhangi bir komutu kullanırken, gerekli tüm bilgileri komut satırında aşağıdaki gibi iletebilirsiniz:

/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

Alternatif olarak, POST'un istek gövdesinde yer alacak bilgileri içeren bir dosya da iletebilirsiniz. Örneğin, aşağıdaki komut sanal ana makineyi tanımlayan bir dosya alır:

/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

Burada vhostcreate dosyası, çağrının POST gövdesini içerir. Bu örnekte, XML biçimli bir istek gövdesi gösterilmektedir:

<VirtualHost name="myVHostUtil">
  <HostAliases>
    <HostAlias>192.168.56.101:9005</HostAlias>
  </HostAliases>
  <Interfaces/>
  <Port>9005</Port>
</VirtualHost>

Hata ayıklama ve API bilgilerini görüntüleme

Komutla ilgili ayrıntılı bilgileri görüntülemek için apigee-adminapi.sh yardımcı programının --debug seçeneğini kullanın. Bu bilgiler, işlemi gerçekleştirmek için apigee-adminapi.sh yardımcı programı tarafından oluşturulan curl komutunu içerir.

Örneğin, aşağıdaki komutta --debug seçeneği kullanılır. Sonuçlar, temel curl komutun çıkışını ayrıntılı modda gösterir:

/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