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

Edge for Private Cloud v. 4.17.01

apigee-adminapi.sh का इस्तेमाल करें सुविधा का इस्तेमाल, Edge कॉन्फ़िगरेशन के वही काम करने के लिए किया जाता है जो आप Edge पर कॉल करके करते हैं मैनेजमेंट एपीआई. 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-adminapi.sh सुविधा apigee-provision या apigee-Validation सुविधा को इंस्टॉल करने पर, यह अपने-आप इंस्टॉल हो जाता है.

उपयोगिता को निम्न स्थान पर इंस्टॉल किया गया है:

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

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

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

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

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

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

आपको कमांड-लाइन स्विच का इस्तेमाल करके या एनवायरमेंट वैरिएबल. कमांड लाइन के आगे एक डैश (-) या डबल डैश लगाएं (--) डालें.

उदाहरण के लिए, "संगठनों के जोड़ना" के लिए, ऊपर दिए गए सहायता लेख से आदेश देते हैं, तो आप संगठन का नाम इनमें से कोई एक:

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

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

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

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

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

किसी फ़ाइल को apigee-adminapi.sh पर पास करना उपयोगिता

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

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

इसके अलावा, आपके पास अनुरोध में शामिल की गई जानकारी वाली फ़ाइल पास करने का भी विकल्प है पोस्ट का मुख्य हिस्सा. उदाहरण के लिए, वर्चुअल होस्ट को परिभाषित करने वाली फ़ाइल लेने के लिए नीचे दिया गया निर्देश दिया जाता है:

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

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

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

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

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

उदाहरण के लिए, यह कमांड --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