การใช้ยูทิลิตี apigee-adminapi.sh

Edge for Private Cloud v4.18.05

ใช้ยูทิลิตี apigee-adminapi.sh เพื่อทำงานการกำหนดค่า Edge แบบเดียวกัน ที่คุณทำได้โดยการเรียกใช้ Edge Management API ข้อได้เปรียบของ ประโยชน์ apigee-adminapi.sh ก็คือ:

  • ใช้อินเทอร์เฟซบรรทัดคำสั่งแบบง่าย
  • ใช้การเติมคำสั่งตามแท็บ
  • ให้ความช่วยเหลือและข้อมูลการใช้งาน
  • แสดงการเรียก API ที่เกี่ยวข้องได้หากคุณตัดสินใจลองใช้ API

ยูทิลิตี apigee-adminapi.sh นี้ไม่สามารถแทนที่ ยูทิลิตี apigee-provision ยูทิลิตี apigee-provision จะใช้องค์ประกอบ apigee-adminapi.sh ยูทิลิตีเพื่อทำงาน

ความแตกต่างหลักๆ ระหว่างทั้ง 2 ฟีเจอร์มีดังนี้

  • ยูทิลิตี apigee-adminapi.sh จะใช้ฟังก์ชันอะตอมที่แทนที่ การเรียก Edge API แต่ละครั้ง ตัวอย่างเช่น ในการสร้างองค์กร สภาพแวดล้อม และสภาพแวดล้อม โฮสต์ต้องมีคำสั่ง apigee-adminapi.sh แยกกัน 3 คำสั่งที่สอดคล้องกับ การเรียก API
  • ยูทิลิตี apigee-provision ได้รับการออกแบบมาให้ทำงานระดับสูง ด้วยคำสั่งเดียว ตัวอย่างเช่น คุณสามารถสร้างองค์กร สภาพแวดล้อม และ โฮสต์เสมือนที่มีคำสั่ง apigee-provision เดียวโดยการส่งไฟล์การกำหนดค่าด้วย ข้อมูลที่จำเป็นทั้งหมด

เอกสารประกอบของ Edge จะใช้ยูทิลิตีทั้ง 2 รายการตามความเหมาะสม

กำลังติดตั้ง apigee-adminapi.sh

ระบบจะติดตั้งยูทิลิตี apigee-adminapi.sh โดยอัตโนมัติเมื่อคุณติดตั้ง apigee-provision หรือยูทิลิตี apigee-validate

ระบบจะติดตั้งเครื่องมือในตำแหน่งต่อไปนี้

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

ไวยากรณ์ /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh

ยูทิลิตี apigee-adminapi.sh ใช้ไวยากรณ์บรรทัดคำสั่งแบบง่าย คุณสามารถใช้ แป้น Tab เพื่อแสดงพรอมต์ที่แสดงรายการตัวเลือกคำสั่งที่ใช้ได้

หากต้องการดูคำสั่งที่เป็นไปได้ทั้งหมด ให้เรียกใช้ยูทิลิตีโดยไม่มีตัวเลือกเลย ดังนี้

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

ถ้าคุณกดปุ่ม Tab หลังจากพิมพ์ apigee-adminapi.sh คุณจะเห็นรายการ ตัวเลือก:

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

แป้น Tab จะแสดงตัวเลือกตามบริบทของคำสั่ง หากคุณป้อนแป้น Tab หลังจากพิมพ์:

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

คุณจะเห็นตัวเลือกที่เป็นไปได้สำหรับการป้อนคำสั่ง orgs ดังนี้

add  apis  apps  delete  envs  list  pods  userroles

ใช้ตัวเลือก -h เพื่อแสดงความช่วยเหลือสำหรับคำสั่งใดก็ได้ ตัวอย่างเช่น หากคุณใช้แท็ก -h ตามที่แสดงด้านล่าง:

/opt/apigee/apigee-adminapi/bin/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

พารามิเตอร์การตั้งค่า โดยใช้สวิตช์บรรทัดคำสั่งและตัวแปรสภาพแวดล้อม

คุณต้องป้อนพารามิเตอร์ทั้งหมดลงในคำสั่งโดยใช้การสลับบรรทัดคำสั่งหรือโดยการใช้ ตัวแปรสภาพแวดล้อม เพิ่มสวิตช์บรรทัดคำสั่งด้วยเครื่องหมายขีดเดียว (-) หรือขีดคู่ (--) ตามที่จำเป็น

เช่น จากความช่วยเหลือที่แสดงด้านบนเกี่ยวกับ "เพิ่มองค์กร" คุณสามารถระบุ ชื่อองค์กรตาม:

  • ใช้สวิตช์บรรทัดคำสั่ง -o ดังต่อไปนี้ วันที่ 
    /opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs -o testOrg
  • การตั้งค่าตัวแปรสภาพแวดล้อมชื่อ ORG: วันที่ 
    > export ORG=testOrg
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs

หากไม่ระบุพารามิเตอร์ที่จําเป็นในคําสั่ง ยูทิลิตีจะแสดงข้อความแสดงข้อผิดพลาด ซึ่งอธิบายพารามิเตอร์ที่ขาดหายไป เช่น หากคุณไม่ใส่ --host หรือ ตัวแปรสภาพแวดล้อม EDGE_SERVER ที่ระบุ Edge Management Server เมื่อสร้าง องค์กร คุณจะเห็นข้อความแสดงข้อผิดพลาดต่อไปนี้

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

พารามิเตอร์ทั่วไป 2 ตัวที่คุณมักตั้งเป็นตัวแปรสภาพแวดล้อม ได้แก่ อีเมลของผู้ดูแลระบบ ที่อยู่และที่อยู่ IP ของเซิร์ฟเวอร์การจัดการ: 

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 เพื่อ สร้างโฮสต์เสมือนหรือคำสั่งใดๆ ที่รับเนื้อหาคำขอ คุณสามารถส่ง ข้อมูลที่จำเป็นในบรรทัดคำสั่งดังที่แสดงด้านล่าง

/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

หรือคุณสามารถส่งไฟล์ที่มีข้อมูลเดียวกันกับที่อยู่ในคำขอ เนื้อหาของ POST เช่น คำสั่งต่อไปนี้ใช้ไฟล์ที่จะกำหนดโฮสต์เสมือน

/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 มีส่วน POST อยู่ ในตัวอย่างนี้ เป็นข้อความคำขอรูปแบบ XML:

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

การแสดงข้อมูลการแก้ไขข้อบกพร่องและ API

ใช้ตัวเลือก --debug กับยูทิลิตี apigee-adminapi.sh เพื่อแสดง โดยละเอียดเกี่ยวกับคำสั่ง ข้อมูลนี้รวมถึงคำสั่ง curl ที่สร้างขึ้นโดย ยูทิลิตี apigee-adminapi.sh เพื่อดำเนินการ

เช่น คำสั่งนี้ใช้ตัวเลือก --debug

/opt/apigee/apigee-adminapi/bin/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