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

Edge for Private Cloud 4.18.05 sürümü

Aynı Edge yapılandırma görevlerini gerçekleştirmek için apigee-adminapi.sh yardımcı programını kullanın uç nokta yönetimi API'sine çağrı yaparak gerçekleştirdiğiniz güvenlik açığıdır. Avantajı, apigee-adminapi.sh yardımcı programı:

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

apigee-adminapi.sh yardımcı programı, apigee-provision yardımcı programı. apigee-provision yardımcı programı aslında apigee-adminapi.sh yardımcı programı.

Bu ikisi arasındaki temel farklar şunlardır:

  • apigee-adminapi.sh yardımcı programı, bağımsız Edge API çağrıları. Örneğin bir kuruluş, ortam ve sanal ortam oluşturmak için barındırıcı için üçe karşılık gelen üç ayrı apigee-adminapi.sh komutu gerektirir API çağrıları.
  • apigee-provision yardımcı programı, hedeflerin her aşamasında tek bir komutla gerçekleştirmeniz gerekir. Örneğin bir kuruluş, ortam oluşturabilir, tek bir apigee-provision komutuna sahip bir yapılandırma dosyası ileterek tüm gerekli bilgileri dahil edin.

Edge belgeleri, uygun olduğunda her iki yardımcı programı da kullanır.

Apigee-adminapi.sh dosyasını yükleme

apigee-adminapi.sh yardımcı programı, apigee-provision veya apigee-validate yardımcı programı.

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

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

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

apigee-adminapi.sh yardımcı programı basit bir komut satırı söz dizimi kullanır. İstediğiniz zaman, sekme tuşuna basarak mevcut komut seçeneklerinin listelendiği bir istem görüntülenmesini sağlayı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, ç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

Parametreleri ayarlama (komut satırı anahtarlarını ve ortam değişkenlerini kullanarak)

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, yukarıdaki yardım bölümünde gösterilen "kuruluş ekleme" komutunun kullanılması durumunda, kuruluş adını girin:

  • -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 veya Oluşturma sırasında Uç Yönetim Sunucusu'nu belirten EDGE_SERVER ortam değişkeni aşağıdaki hata mesajını görüyorsunuz:

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, sys yönetici e-postasıdır Yönetim Sunucusu'nun adresi ve IP adresi: 

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

Apigee-adminapi.sh öğesine dosya iletme elektrik, su veya doğalgaz

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 bir web sitesi ana makine, postadaki sanal ana makine hakkında bilgi gerektiren bir POST API çağrısına karşılık gelir: istek gövdesi.

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 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örüntüleme

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, apigee-adminapi.sh yardımcı programını kullanın.

Örneğin, aşağıdaki komut --debug seçeneğini kullanır:

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

Oluşturulan curl komutuyla birlikte 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