apigee-adminapi.sh
เรียกใช้ Edge Management API เพื่อดำเนินงานบำรุงรักษาจำนวนมาก
เกี่ยวกับ apigee-adminapi.sh
เรียกใช้ apigee-adminapi.sh
คุณเรียกใช้ apigee-adminapi.sh
จากโหนดเซิร์ฟเวอร์การจัดการ เมื่อเรียกใช้ยูทิลิตี คุณต้องกำหนดสิ่งต่อไปนี้เป็นตัวแปรสภาพแวดล้อมหรือตัวเลือกบรรทัดคำสั่ง
ADMIN_EMAIL
(ตรงกับตัวเลือกบรรทัดคำสั่งadmin
)ADMIN_PASSWORD
(pwd
)EDGE_SERVER
(host
)
ตัวอย่างต่อไปนี้เรียกใช้ apigee-adminapi.sh
และส่งค่าที่จำเป็นเป็นตัวเลือกของบรรทัดคำสั่ง
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh buildinfo list --admin user@example.com --pwd abcd1234 --host localhost
ตัวอย่างต่อไปนี้กำหนดตัวเลือกที่จำเป็นเป็นตัวแปรสภาพแวดล้อมชั่วคราว จากนั้นเรียกใช้ยูทิลิตี apigee-adminapi.sh
export ADMIN_EMAIL=user@example.comexport ADMIN_PASSWORD=abcd1234
export EDGE_SERVER=192.168.56.101
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh servers list
หากไม่ส่งรหัสผ่านเป็นตัวเลือกหรือกำหนดให้เป็นตัวแปรสภาพแวดล้อม apigee-adminapi.sh
จะแจ้งให้ป้อนรหัสผ่าน
ตั้งค่าพารามิเตอร์ apigee-adminapi.sh
คุณต้องป้อนพารามิเตอร์ทั้งหมดลงในคำสั่งโดยใช้การเปลี่ยนบรรทัดคำสั่งหรือโดยใช้ตัวแปรสภาพแวดล้อม ใส่เครื่องหมายขีดคั่นเดี่ยว (-) หรือเครื่องหมายขีดคู่ (--) ไว้ด้านหน้าสวิตช์บรรทัดคำสั่ง
เช่น คุณจะระบุชื่อองค์กรได้โดยใช้วิธีใดวิธีหนึ่งต่อไปนี้
- การใช้สวิตช์บรรทัดคำสั่ง
-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
) apigee-adminapi.sh
จะตอบสนองด้วยข้อผิดพลาดต่อไปนี้
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
หากคุณได้รับข้อผิดพลาด HTTP STATUS CODE: 401
แสดงว่าคุณป้อนรหัสผ่านผิด
รับความช่วยเหลือ 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 หลังจากที่พิมพ์ ให้ทำดังนี้
/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
ส่งไฟล์ไปที่ apigee-adminapi.sh
ยูทิลิตี apigee-adminapi.sh
เป็น Wrapper ที่ประมาณ curl
ดังนั้นคำสั่งบางอย่างจะสอดคล้องกับการเรียก API PUT
และ POST
ที่รับเนื้อหาของคำขอ
เช่น การสร้างโฮสต์เสมือนจะสอดคล้องกับการเรียก API POST
ที่ต้องใช้ข้อมูลเกี่ยวกับโฮสต์เสมือนในเนื้อหาคำขอ
เมื่อใช้ยูทิลิตี 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
ผลลัพธ์จะแสดงเอาต์พุตของคำสั่ง curl
ที่สำคัญในโหมดแบบละเอียด ดังนี้
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug 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