Edge for Private Cloud เวอร์ชัน 4.17.09
ใช้ยูทิลิตี apigee-adminapi.sh เพื่อทำงานการกำหนดค่า Edge เดียวกันกับที่คุณทำโดยการเรียกใช้ API การจัดการ Edge ข้อดีของยูทิลิตี 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 3 รายการ
- ยูทิลิตี apigee-provision ออกแบบมาเพื่อดำเนินการระดับสูงอย่างสมบูรณ์ในคำสั่งเดียว เช่น คุณสามารถสร้างองค์กร สภาพแวดล้อม และโฮสต์เสมือนด้วยคำสั่ง apigee-provision เพียงคำสั่งเดียวโดยส่งไฟล์การกำหนดค่าพร้อมข้อมูลที่จำเป็นทั้งหมด
เอกสารประกอบของ Edge ใช้ทั้ง 2 ยูทิลิตีตามความเหมาะสม
กำลังติดตั้ง apigee-adminapi.sh
ระบบจะติดตั้งยูทิลิตี apigee-adminapi.sh โดยอัตโนมัติเมื่อคุณติดตั้งยูทิลิตี apigee-provision หรือ apigee-validate
ยูทิลิตีจะติดตั้งในตำแหน่งต่อไปนี้
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
ไวยากรณ์ apigee-adminapi.sh
ยูทิลิตี apigee-adminapi.sh ใช้ไวยากรณ์บรรทัดคำสั่งที่เรียบง่าย คุณสามารถใช้แป้น Tab เพื่อแสดงข้อความแจ้งที่แสดงรายการตัวเลือกคำสั่งที่ใช้ได้ทุกเมื่อ
หากต้องการดูคำสั่งที่เป็นไปได้ทั้งหมด ให้เรียกใช้ยูทิลิตีโดยไม่มีตัวเลือก ดังนี้
> apigee-adminapi.sh
หากกดแป้น Tab หลังจากพิมพ์ apigee-adminapi.sh คุณจะเห็นรายการตัวเลือกที่เป็นไปได้ดังนี้
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
หากคุณละเว้นพารามิเตอร์ที่จำเป็นสำหรับคำสั่ง ยูทิลิตีจะแสดงข้อความแสดงข้อผิดพลาดที่อธิบายพารามิเตอร์ที่ขาดหายไป ตัวอย่างเช่น หากคุณละเว้นตัวแปรสภาพแวดล้อม --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 บางคำสั่งสอดคล้องกับการเรียก API PUT และ POST ที่ใช้เนื้อหาคำขอ ตัวอย่างเช่น การสร้างโฮสต์เสมือนจะสอดคล้องกับการเรียก API 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 ของการเรียก ในตัวอย่างนี้ เนื้อหาของคำขออยู่ในรูปแบบ 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
> 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