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

Edge for Private Cloud 4.18.05 sürümü

Edge Management API'ye çağrı yaparak gerçekleştirdiğiniz Edge yapılandırma görevlerini gerçekleştirmek için apigee-adminapi.sh yardımcı programını kullanın. apigee-adminapi.sh yardımcı programının avantajı şudur:

  • Basit bir komut satırı arayüzü kullanma
  • Sekme tabanlı komut tamamlama uygular
  • Yardım ve kullanım bilgileri sağlar
  • API'yi denemeye karar verirseniz ilgili API çağrısını görüntüleyebilir.

apigee-adminapi.sh yardımcı programı, apigee-provision yardımcı programının yerine geçmez. apigee-provision yardımcı programı, görevlerini gerçekleştirmek için apigee-adminapi.sh yardımcı programını kullanır.

İkisi arasındaki temel farklar şunlardır:

  • apigee-adminapi.sh yardımcı programı, bağımsız Edge API çağrılarının yerine geçen atomik işlevleri gerçekleştirir. Örneğin; kuruluş, ortam ve sanal ana makine oluşturmak için üç API çağrısına karşılık gelen üç ayrı apigee-adminapi.sh komutu gerekir.
  • apigee-provision yardımcı programı, tek bir komutta eksiksiz bir üst düzey işlem gerçekleştirecek şekilde tasarlanmıştır. Örneğin, gerekli tüm bilgileri içeren bir yapılandırma dosyası ileterek tek bir apigee-provision komutuyla kuruluş, ortam ve sanal ana makine oluşturabilirsiniz.

Edge belgelerinde, uygun durumlarda her iki yardımcı program da kullanılır.

Apigee-adminapi.sh yükleme

apigee-provision veya apigee-validate yardımcı programını yüklediğinizde apigee-adminapi.sh yardımcı programı otomatik olarak yüklenir.

Yardımcı program şu konuma yüklenir:

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

/opt/Apigee/Apigee-adminapi/bin/Apigee-adminapi.sh söz dizimi

apigee-adminapi.sh yardımcı programı basit bir komut satırı söz dizimi kullanır. 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

Komut satırı anahtarlarını ve ortam değişkenlerini kullanarak parametreleri 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ş ekleme" komutu için yukarıda gösterilen yardım bölümünde kuruluş adını iki şekilde 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, bir kuruluş oluştururken Edge Management Server'ı (Uç Yönetim Sunucusu) belirten --host veya EDGE_SERVER ortam değişkenini çıkarırsanız aşağıdaki hata mesajını görürsünüz:

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

Genellikle ortam değişkeni olarak ayarladığınız iki yaygın parametre, sistem yöneticisi e-posta adresi ve Yönetim Sunucusu'nun IP adresidir. 

export ADMIN_EMAIL=foo@bar.com
export EDGE_SERVER=192.168.56.101

Apigee-adminapi.sh yardımcı programına dosya iletme

Bazı apigee-adminapi.sh yardımcı program 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övdesinde sanal ana makine hakkında bilgi gerektiren 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ı, çağrının POST gövdesini içerir. 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örüntüleme

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, şu komutta --debug seçeneği kullanılır:

/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug

Ayrıca, oluşturulan curl komutunu da içeren aşağıdaki çıkışı görüntüler:

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