apigee-adminapi.sh के यूटिलिटी टूल का इस्तेमाल करना

Edge for Private Cloud v4.18.01

Edge मैनेजमेंट एपीआई को कॉल करके, Edge कॉन्फ़िगरेशन के जो टास्क किए जाते हैं उन्हें apigee-adminapi.sh यूटिलिटी का इस्तेमाल करके भी किया जा सकता है. apigee-adminapi.sh यूटिलिटी का फ़ायदा यह है कि:

  • आसान कमांड-लाइन इंटरफ़ेस का इस्तेमाल करना
  • टैब-आधारित कमांड पूरा करने की सुविधा लागू करता है
  • सहायता और इस्तेमाल के बारे में जानकारी देता है
  • अगर आपको एपीआई को आज़माना है, तो उससे जुड़ा एपीआई कॉल दिखाया जा सकता है

apigee-adminapi.sh यूटिलिटी, apigee-provision यूटिलिटी की जगह नहीं ले सकती. apigee-provision यूटिलिटी, अपने टास्क पूरे करने के लिए apigee-adminapi.sh यूटिलिटी का इस्तेमाल करती है.

दोनों के बीच मुख्य अंतर ये हैं:

  • apigee-adminapi.sh यूटिलिटी, ऐसे ऐटॉमिक फ़ंक्शन करती है जो अलग-अलग Edge एपीआई कॉल को बदल देते हैं. उदाहरण के लिए, संगठन, एनवायरमेंट, और वर्चुअल होस्ट बनाने के लिए, तीन अलग-अलग apigee-adminapi.sh कमांड की ज़रूरत होती है. ये कमांड, तीन एपीआई कॉल के हिसाब से होते हैं.
  • apigee-provision यूटिलिटी को एक ही निर्देश में, हाई-लेवल के पूरे ऑपरेशन को पूरा करने के लिए डिज़ाइन किया गया है. उदाहरण के लिए, ज़रूरी जानकारी वाली कॉन्फ़िगरेशन फ़ाइल को पास करके, एक ही apigee-provision कमांड से संगठन, एनवायरमेंट, और वर्चुअल होस्ट बनाया जा सकता है.

Edge के दस्तावेज़ में, ज़रूरत के हिसाब से दोनों यूटिलिटी का इस्तेमाल किया जाता है.

apigee-adminapi.sh इंस्टॉल करना

apigee-provision या apigee-validate यूटिलिटी इंस्टॉल करने पर, apigee-adminapi.sh यूटिलिटी अपने-आप इंस्टॉल हो जाती है.

यूटिलिटी को इस जगह पर इंस्टॉल किया जाता है:

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

apigee-adminapi.sh सिंटैक्स

apigee-adminapi.sh यूटिलिटी, एक आसान कमांड लाइन सिंटैक्स का इस्तेमाल करती है. किसी भी समय, Tab बटन का इस्तेमाल करके एक प्रॉम्प्ट दिखाएं. इसमें उपलब्ध कमांड के विकल्पों की सूची होती है.

सभी संभावित निर्देश देखने के लिए, बिना किसी विकल्प के यूटिलिटी को शुरू करें:

> apigee-adminapi.sh

अगर apigee-adminapi.sh टाइप करने के बाद, Tab बटन दबाया जाता है, तो आपको संभावित विकल्पों की सूची दिखेगी: 

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

Tab बटन दबाने पर, कमांड के हिसाब से विकल्प दिखते हैं. टाइप करने के बाद, Tab बटन दबाने पर:

> apigee-adminapi.sh orgs

आपको orgs कमांड को पूरा करने के लिए, ये विकल्प दिखेंगे:

add  apis  apps  delete  envs  list  pods  userroles

किसी भी निर्देश के बारे में मदद पाने के लिए, -h विकल्प का इस्तेमाल करें. उदाहरण के लिए, अगर आपने यहां दिए गए -h विकल्प का इस्तेमाल किया है:

> apigee-adminapi.sh orgs -h

यह यूटिलिटी, orgs कमांड के लिए सभी संभावित विकल्पों की पूरी जानकारी दिखाती है. आउटपुट में मौजूद पहला आइटम, "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

कमांड-लाइन स्विच और एनवायरमेंट वैरिएबल का इस्तेमाल करके, पैरामीटर सेट करना

आपको कमांड-लाइन स्विच या एनवायरमेंट वैरिएबल का इस्तेमाल करके, किसी निर्देश के लिए सभी पैरामीटर डालने होंगे. ज़रूरत के हिसाब से, कमांड लाइन स्विच से पहले एक डैश (-) या डबल डैश (--) लगाएं.

उदाहरण के लिए, "orgs add" कमांड के लिए ऊपर दी गई मदद से, संगठन का नाम इनमें से किसी एक तरीके से बताया जा सकता है:

  • -o कमांड लाइन स्विच का इस्तेमाल करना:
    > apigee-adminapi.sh orgs -o testOrg
  • ORG नाम का एनवायरमेंट वैरिएबल सेट करना:
    > export ORG=testOrg
    > apigee-adminapi.sh orgs

अगर आपने कमांड में कोई ज़रूरी पैरामीटर शामिल नहीं किया है, तो यूटिलिटी गड़बड़ी का मैसेज दिखाती है. इसमें, मौजूद नहीं होने वाले पैरामीटर के बारे में बताया जाता है. उदाहरण के लिए, अगर संगठन बनाते समय Edge मैनेजमेंट सर्वर की जानकारी देने वाले --host या EDGE_SERVER एनवायरमेंट वैरिएबल को शामिल नहीं किया जाता है, तो आपको गड़बड़ी का यह मैसेज दिखेगा:

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

आम तौर पर, एनवायरमेंट वैरिएबल के तौर पर सेट किए जाने वाले दो सामान्य पैरामीटर, सिस्टम एडमिन का ईमेल पता और मैनेजमेंट सर्वर का आईपी पता होते हैं: 

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

apigee-adminapi.sh यूटिलिटी को फ़ाइल पास करना

कुछ apigee-adminapi.sh यूटिलिटी कमांड, PUT और POST एपीआई कॉल से जुड़े होते हैं. ये कॉल, अनुरोध के मुख्य हिस्से को लेते हैं. उदाहरण के लिए, वर्चुअल होस्ट बनाने के लिए, POST एपीआई कॉल की ज़रूरत होती है. इसके लिए, अनुरोध के मुख्य हिस्से में वर्चुअल होस्ट की जानकारी देना ज़रूरी है.

वर्चुअल होस्ट बनाने के लिए, apigee-adminapi.sh यूटिलिटी या अनुरोध के मुख्य हिस्से को इस्तेमाल करने वाले किसी भी निर्देश का इस्तेमाल करते समय, कमांड लाइन पर सभी ज़रूरी जानकारी पास की जा सकती है. इसके बारे में यहां बताया गया है:

> 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

इसके अलावा, ऐसी फ़ाइल भी पास की जा सकती है जिसमें वही जानकारी हो जो POST के अनुरोध के मुख्य हिस्से में मौजूद होगी. उदाहरण के लिए, नीचे दिया गया कमांड, वर्चुअल होस्ट के बारे में बताने वाली फ़ाइल लेता है:

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

जहां फ़ाइल vhostcreate में कॉल का POST मुख्य हिस्सा शामिल होता है. इस उदाहरण में, अनुरोध का मुख्य हिस्सा एक्सएमएल फ़ॉर्मैट में है:

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

डीबग और एपीआई की जानकारी देखना

कमांड के बारे में ज़्यादा जानकारी देखने के लिए, apigee-adminapi.sh यूटिलिटी में --debug विकल्प का इस्तेमाल करें. इस जानकारी में, कार्रवाई करने के लिए apigee-adminapi.sh यूटिलिटी से जनरेट किया गया cURL कमांड शामिल होता है.

उदाहरण के लिए, इस कमांड में --debug विकल्प का इस्तेमाल किया गया है:

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

साथ ही, जनरेट किए गए cURL कमांड के साथ यह आउटपुट दिखाता है:

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