Private Cloud için Edge v. 4.17.05
Edge yönetim API'sine çağrı yaparak yaptığınız 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 avantajları şunlardır:
- Basit bir komut satırı arayüzü kullanın
- Sekmeyle komut tamamlama özelliğini 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 yerini almaz. apigee-provision yardımcı programı, aslında görevlerini gerçekleştirmek için apigee-adminapi.sh yardımcı programını kullanır.
Bu iki veri türü arasındaki temel farklar şunlardır:
- apigee-adminapi.sh yardımcı programı, tek tek Edge API çağrılarının yerini alan atomik işlevler gerçekleştirir. Örneğin, bir 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 komutla üst düzey bir işlemin tamamını gerçekleştirmek için tasarlanmıştır. Örneğin, gerekli tüm bilgileri içeren bir yapılandırma dosyası göndererek tek bir apigee-provision komutuyla kuruluş, ortam ve sanal ana makine oluşturabilirsiniz.
Edge dokümanlarında, uygun olduğunda her iki yardımcı program da kullanılır.
apigee-adminapi.sh'yi yükleme
apigee-adminapi.sh yardımcı programı, apigee-provision veya apigee-validate yardımcı programını yüklediğinizde otomatik olarak yüklenir.
Yardımcı program şu konuma yüklenir:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
apigee-adminapi.sh söz dizimi
apigee-adminapi.sh yardımcı programı basit bir komut satırı sözdizimi kullanır. İstediğiniz zaman sekme tuşunu kullanarak mevcut komut seçeneklerini listeleyen bir istem görüntüleyebilirsiniz.
Olası tüm komutları görmek için yardımcı programı seçenek olmadan çağırın:
> 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:
> 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 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:
> apigee-adminapi.sh orgs -h
Yardımcı program, orgs komutunun tüm olası seçenekleri için eksiksiz yardım bilgilerini gösterir. Çıktıda 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
Komut satırı anahtarları ve ortam değişkenlerini kullanarak parametreleri ayarlama
Komut satırı anahtarları veya ortam değişkenleri kullanarak komuta tüm parametreleri girmeniz gerekir. Komut satırı anahtarlarının önüne gerektiği gibi tek kısa çizgi (-) veya çift kısa çizgi (--) ekleyin.
Örneğin, "orgs add" komutu için yukarıda gösterilen yardım bölümünden kuruluş adını şu şekilde belirtebilirsiniz:
- -o komut satırı anahtarını kullanarak:
> apigee-adminapi.sh orgs -o testOrg - ORG adlı bir ortam değişkeni ayarlama:
> export ORG=testOrg
> apigee-adminapi.sh orgs
Komut için gerekli parametreleri atlarsanız yardımcı program, eksik parametreleri açıklayan bir hata mesajı görüntüler. Örneğin, kuruluş oluştururken Edge Yönetim Sunucusu'nu belirten --host veya EDGE_SERVER ortam değişkenini atlarsanı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, yönetim sunucusunun sistem yöneticisi e-posta adresi ve IP adresidir:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
apigee-adminapi.sh yardımcı programına dosya gönderme
Bazı apigee-adminapi.sh yardımcı program komutları, istek gövdesi 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 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ına aşağıdaki gibi iletebilirsiniz:
> 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 isteği gövdesinde yer alan bilgilerle aynı bilgileri içeren bir dosya da iletebilirsiniz. Örneğin, aşağıdaki komutta sanal ana makineyi tanımlayan bir dosya kullanılır:
> 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övdesi verilmiştir:
<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ı bilgi görüntülemek için apigee-adminapi.sh yardımcı programında --debug seçeneğini kullanın. Bu bilgiler arasında, işlemi gerçekleştirmek için apigee-adminapi.sh yardımcı programı tarafından oluşturulan cURL komutu da yer alır.
Örneğin, bu komutta --debug seçeneği kullanılmaktadır:
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
Oluşturulan cURL komutu da dahil olmak üzere aşağıdaki çıkışı gösterir:
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