Menggunakan utilitas apigee-adminapi.sh

Edge untuk Private Cloud v. 4.16.05

Gunakan utilitas apigee-adminapi.sh untuk melakukan tugas konfigurasi Edge yang sama dengan yang Anda lakukan dengan melakukan panggilan ke Edge Management API. Keuntungan utilitas apigee-adminapi.sh adalah:

  • Menggunakan antarmuka command line sederhana
  • Menerapkan penyelesaian perintah berbasis tab
  • Memberikan bantuan dan informasi penggunaan
  • Dapat menampilkan panggilan API yang sesuai jika Anda memutuskan untuk mencoba API

Utilitas apigee-adminapi.sh bukanlah pengganti untuk utilitas apigee-provider. Utilitas apigee-appeal sebenarnya menggunakan utilitas apigee-adminapi.sh untuk menjalankan tugasnya.

Perbedaan utama di antara keduanya adalah:

  • Utilitas apigee-adminapi.sh menjalankan fungsi atomik yang menggantikan setiap panggilan Edge API. Misalnya, untuk membuat organisasi, lingkungan, dan host virtual, diperlukan tiga perintah apigee-adminapi.sh terpisah yang sesuai dengan tiga panggilan API.
  • Utilitas apigee-provide dirancang untuk menjalankan operasi tingkat tinggi yang lengkap dalam satu perintah. Misalnya, Anda dapat membuat organisasi, lingkungan, dan host virtual dengan satu perintah apigee- providers dengan meneruskan file konfigurasi yang berisi semua informasi yang diperlukan.

Dokumentasi Edge menggunakan kedua aplikasi utilitas tersebut jika diperlukan.

Menginstal apigee-adminapi.sh

Utilitas apigee-adminapi.sh secara otomatis diinstal saat Anda menginstal utilitas apigee-provider atau apigee-validate.

Utilitas diinstal di lokasi berikut:

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

Sintaksis apigee-adminapi.sh

Utilitas apigee-adminapi.sh menggunakan sintaks command line sederhana. Gunakan tombol tab kapan saja untuk menampilkan perintah yang mencantumkan opsi perintah yang tersedia.

Untuk melihat semua perintah yang mungkin, panggil utilitas tanpa opsi:

> apigee-adminapi.sh 

Jika menekan tombol tab setelah mengetik apigee-adminapi.sh, Anda akan melihat daftar kemungkinan opsi:

analytics  classification  logsessions  regions  securityprofile  userroles
buildinfo  GET             orgs         runtime  servers          users

Tombol tab menampilkan opsi berdasarkan konteks perintah. Jika Anda memasukkan tombol tab setelah mengetik:

> apigee-adminapi.sh orgs

Anda akan melihat opsi untuk menyelesaikan perintah orgs:

add  apis  apps  delete  envs  list  pods  userroles

Gunakan opsi -h untuk menampilkan bantuan untuk perintah apa pun. Misalnya, jika Anda menggunakan opsi -h seperti ditunjukkan di bawah ini:

> apigee-adminapi.sh orgs -h

Alat ini menampilkan informasi bantuan lengkap untuk semua opsi yang memungkinkan untuk perintah orgs. Item pertama dalam output menunjukkan bantuan untuk perintah "orgs add":

+++++++++++++++++++++++++++++++++++++++++++
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

Menetapkan parameter menggunakan tombol command line dan variabel lingkungan

Anda harus memasukkan semua parameter ke perintah dengan menggunakan tombol command line, atau menggunakan variabel lingkungan. Awali tombol command line dengan tanda hubung tunggal (-) atau tanda pisah ganda (--) sesuai kebutuhan.

Misalnya, dari bantuan yang ditampilkan di atas untuk perintah "orgs add", Anda dapat menentukan nama organisasi dengan:

  • Menggunakan tombol command line -o:
    > apigee-adminapi.sh orgs -o testOrg
  • Menetapkan variabel lingkungan bernama ORG:
    > Export ORG=testOrg
    > apigee-adminapi.sh orgs

Jika Anda menghilangkan parameter yang diperlukan pada perintah, utilitas akan menampilkan pesan error yang menjelaskan parameter yang tidak ada. Misalnya, jika Anda menghilangkan variabel lingkungan --host atau EDGE_SERVER yang menentukan Server Pengelolaan Edge saat membuat organisasi, Anda akan melihat pesan error berikut:

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

Dua parameter umum yang sering Anda tetapkan sebagai variabel lingkungan adalah alamat email admin sistem dan alamat IP Server Pengelolaan:

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

Meneruskan file ke utilitas apigee-adminapi.sh

Beberapa perintah utilitas apigee-adminapi.sh berkaitan dengan panggilan API PUT dan POST yang menggunakan isi permintaan. Misalnya, pembuatan host virtual berkaitan dengan panggilan POST API yang memerlukan informasi mengenai host virtual dalam isi permintaan.

Saat menggunakan utilitas apigee-adminapi.sh untuk membuat host virtual, atau perintah apa pun yang menggunakan isi permintaan, Anda dapat meneruskan semua informasi yang diperlukan pada command line seperti ditunjukkan di bawah ini:

> 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

Atau, Anda dapat meneruskan file yang berisi informasi yang sama seperti yang akan dimuat dalam isi permintaan POST. Misalnya, perintah berikut mengambil file yang menentukan host virtual:

> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate

dengan file vhostcreate berisi isi POST panggilan. Dalam contoh ini, ini adalah isi permintaan berformat XML:

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

Menampilkan informasi API dan debug

Gunakan opsi --debug ke utilitas apigee-adminapi.sh untuk menampilkan informasi mendetail tentang perintah. Informasi ini mencakup perintah cURL yang dihasilkan oleh utilitas apigee-adminapi.sh untuk menjalankan operasi.

Misalnya, perintah ini menggunakan opsi --debug:

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

Dan menampilkan output berikut, termasuk perintah cURL yang dihasilkan:

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