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

Edge for Private Cloud v4.19.01

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.com
export 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 จะแสดงตัวเลือกตามบริบทของคำสั่ง หากคุณป้อนแป้น 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