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 öğesini çağırma

apigee-adminapi.sh öğesini bir Yönetim Sunucusu düğümünden çağırıyorsunuz. Yardımcı programı çağırırken 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 yöntemini çağırır ve gerekli değerleri komut satırı seçenekleri olarak iletir:

/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ımlanıp apigee-adminapi.sh yardımcı programını çağırmaktadı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

Komut satırı anahtarlarını veya ortam değişkenlerini kullanarak tüm parametreleri bir komuta girmeniz gerekir. Komut satırı anahtarlarının önüne tek bir kısa çizgi (-) veya çift kısa çizgi (--) ile gerektiği gibi ekleyin.

Örneğin, kuruluş adını şu yöntemlerden birini kullanarak belirtebilirsiniz:

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

Gerekli parametreleri komuta atlarsanız yardımcı program eksik parametreleri açıklayan bir hata mesajı görüntüler. Örneğin, --host seçeneğini (EDGE_SERVER ortam değişkenine karşılık gelir) çıkarırsanı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şsinizdir.

Apigee-adminapi.sh 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ı hiç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örüntüler. Sekme tuşunu yazdıktan sonra girerseniz:

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

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

add  apis  apps  delete  envs  list  pods  userroles

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

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

Yardımcı program orgs komutu için kullanılabilecek tüm seçenekler için eksiksiz yardım bilgilerini görüntüler. Çıkıştaki ilk öğe, orgs add komutunun yardımını 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 dosyasına bir dosya iletin

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

apigee-adminapi.sh yardımcı programını kullanarak sanal ana makine veya istek gövdesini alan herhangi bir komut oluştururken, gerekli tüm bilgileri komut satırında aşağıda gösterildiği gibi aktarabilirsiniz:

/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 alan bilgilerin aynısını içeren bir dosya aktarabilirsiniz. Örneğin, aşağıdaki komut, sanal ana bilgisayarı 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

vhostcreate dosyasının, çağrının POST gövdesini içerdiği yer. Bu örnekte, XML biçimli bir istek gövdesidir:

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

Hata ayıklama ve API bilgilerini göster

Komut hakkında ayrıntılı bilgileri görüntülemek için apigee-adminapi.sh yardımcı programında --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 komutunun çı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