Edge for Private Cloud v. 4.16.09
ใช้ยูทิลิตี apigee-adminapi.sh เพื่อทํางานกําหนดค่า Edge เดียวกันกับที่คุณทําโดยการเรียกใช้ API การจัดการ Edge ข้อดีของยูทิลิตี apigee-adminapi.sh คือ ยูทิลิตีนี้
- ใช้อินเทอร์เฟซบรรทัดคำสั่งแบบง่าย
- ใช้การเติมคำสั่งอัตโนมัติแบบ Tab
- ให้ความช่วยเหลือและข้อมูลการใช้งาน
- แสดงการเรียก 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 จะใช้ยูทิลิตีทั้งคู่ตามความเหมาะสม
การติดตั้ง 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
การตั้งค่าพารามิเตอร์โดยใช้สวิตช์บรรทัดคำสั่งและตัวแปรสภาพแวดล้อม
คุณต้องป้อนพารามิเตอร์ทั้งหมดในคําสั่งโดยใช้สวิตช์บรรทัดคําสั่ง หรือใช้ตัวแปรสภาพแวดล้อม ใส่เครื่องหมายขีดกลาง (-) หรือขีดกลาง 2 ขีด (--) ไว้หน้าสวิตช์บรรทัดคำสั่งตามที่จำเป็น
ตัวอย่างเช่น จากความช่วยเหลือที่แสดงด้านบนสำหรับคําสั่ง "orgs add" คุณสามารถระบุชื่อองค์กรได้ดังนี้
- ใช้บรรทัดคำสั่ง -o
Switch:
> 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 ที่ใช้เนื้อความของคำขอ เช่น การสร้างโฮสต์เสมือนจะสอดคล้องกับการเรียก 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
หรือจะส่งไฟล์ที่มีข้อมูลเดียวกันกับที่อยู่ในเนื้อหาคำขอ POST ก็ได้ ตัวอย่างเช่น คำสั่งต่อไปนี้จะนําไฟล์ที่กําหนดโฮมเสมือน
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
โดยที่ไฟล์ vhostcreate จะมีข้อมูลใน Body ของ 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