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

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

Apigee-adminapi.sh hakkında

Apigee-adminapi.sh kodunu çağırma

apigee-adminapi.sh öğesini 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ımlayın:

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

Aşağıdaki örnek apigee-adminapi.sh yöntemini çağırır ve gerekli değerleri komut satırı olarak iletir seçenekler:

/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ımlanmaktadır ve ardından apigee-adminapi.sh yardımcı programını çağırı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 bir ortam değişkeni olarak tanımlamazsanız apigee-adminapi.sh, kodu girmenizi ister.

Apigee-adminapi.sh parametrelerini ayarlama

Tüm parametreleri, komut satırı anahtarlarını veya değişkenlerine odaklanmalıdır. Komut satırı anahtarlarının önüne tek kısa çizgi (-) veya çift tire ile başlayın (--) işaretini kaldırın.

Örneğin, kuruluş adını aşağıdakilerden birine göre 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
ziyaret edin.

Gerekli parametreleri komuta atlarsanız yardımcı program bir hata mesajı gösterir eksik parametreleri açıklayacağım. Örneğin, --host seçeneğini atlarsanız (EDGE_SERVER ortam değişkenine karşılık gelir), apigee-adminapi.sh yanıt verir şu hata ile:

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

HTTP STATUS CODE: 401 hatası alırsanız yanlış giriş yapmışsınız demektir şifre.

Apigee-adminapi.sh yardımı alma

İstediğiniz zaman sekme tuşunu kullanarak kullanılabilir komut seçeneklerini listeleyen bir istem görüntüleyebilirsiniz.

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, çalıştırabileceğiniz seçenekler:

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 girerseniz yazdıktan sonra:

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

orgs komutunu tamamlamak için kullanılabilecek seçenekleri görürsünüz:

add  apis  apps  delete  envs  list  pods  userroles

Herhangi bir komutla ilgili yardımın görüntülenmesi için -h seçeneğini kullanın. Örneğin, -h seçeneği aşağıda verilmiştir:

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

Yardımcı program, orgs komutudur. Çıkıştaki ilk öğe, orgs add komutu:

+++++++++++++++++++++++++++++++++++++++++++
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 öğesine dosya iletme

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

apigee-adminapi.sh yardımcı programını şunun için kullanırken: bir sanal ana makine veya istek gövdesi alan herhangi bir komut oluşturduğunuzda, komut satırındaki gerekli bilgileri aşağıda gösterildiği gibi bulabilirsiniz:

/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, istekte yer alan bilgilerle aynı bilgileri içeren bir dosyayı iletebilirsiniz. POST gövdesidir. Örneğin, aşağıdaki komut, sanal ana makineyi tanımlayan bir dosyayı 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 durum. İçinde 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

Görüntülemek için apigee-adminapi.sh yardımcı programının --debug seçeneğini kullanın komut hakkında ayrıntılı bilgi edindiniz. Bu bilgiler, curl komutunu içerir apigee-adminapi.sh yardımcı programı tarafından oluşturulan kodu girin.

Örneğin, aşağıdaki komut --debug seçeneğini kullanır. Sonuçlar temel curl komutunun çıkışını ayrıntılı modda görüntüleyin:

/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