จัดการคอลเล็กชันโดยใช้ API

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X
ข้อมูล

คอลเล็กชันช่วยให้คุณจัดกลุ่มพร็อกซี API, เป้าหมาย หรือแอปของนักพัฒนาซอฟต์แวร์ และกําหนดค่าเกณฑ์ที่เหมาะสมให้กับสมาชิกทุกคนในกลุ่มเพื่อให้วินิจฉัยปัญหาได้เร็วขึ้น

ส่วนต่อไปนี้จะอธิบายวิธีจัดการคอลเล็กชันโดยใช้ API

ดู API คอลเล็กชันสำหรับข้อมูลเพิ่มเติมเกี่ยวกับ API คอลเล็กชัน

สร้างคอลเล็กชันโดยใช้ API

สร้างคอลเล็กชันของพร็อกซี API โดยการส่งคำขอ POST ไปยังทรัพยากรต่อไปนี้: https://apimonitoring.enterprise.apigee.com/collections

ตัวอย่างต่อไปนี้แสดงวิธีสร้างคอลเล็กชัน

curl 'https://apimonitoring.enterprise.apigee.com/collections' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Collection",
     "description":"My collection for critical APIs",
     "environment": "prod",
     "type": "proxy",
     "members":["proxy1", "proxy2"]
    }'

ตั้งค่า $ACCESS_TOKEN เป็นโทเค็นเพื่อการเข้าถึง OAuth 2.0 ตามที่อธิบายไว้ในหัวข้อรับโทเค็นเพื่อการเข้าถึง OAuth 2.0

ดูข้อมูลเกี่ยวกับตัวเลือก cURL ที่ใช้ในตัวอย่างนี้ได้ที่ใช้ cURL

คุณสามารถระบุค่า type เป็น proxy, target หรือ developerApp เช่น หากต้องการสร้างคอลเล็กชันแอปของนักพัฒนาซอฟต์แวร์ ให้ทำดังนี้

curl 'https://apimonitoring.enterprise.apigee.com/collections' \
  -X POST \
  -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json"\
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
     "organization":"myorg",
     "name":"My Dev App Collection",
     "description":"My collection for critical apps",
     "environment": "prod",
     "type": "developerApp",
     "members":["app1", "app2"]
    }'

ดูคอลเล็กชันทั้งหมดที่ใช้ API

ดูการแจ้งเตือนทั้งหมดโดยการส่งคำขอ GET ไปยังแหล่งข้อมูลต่อไปนี้: https://apimonitoring.enterprise.apigee.com/collections

คุณต้องส่งชื่อองค์กรโดยใช้พารามิเตอร์การค้นหา org

เช่น

curl 'https://apimonitoring.enterprise.apigee.com/collections?org=myorg' 
  -X GET
  -H 'Accept: application/json, text/plain, */*' 
  -H "Authorization: Bearer $ACCESS_TOKEN"    

ตัวอย่างคําตอบต่อไปนี้

[{
     "uuid":"1234abcd",
     "organization":"myorg",
     "environment": "prod",
     "name":"My Collection",
     "type": "proxy",
     "members":["proxy1", "proxy2"],
     "description":"My collection for critical APIs",
     "updatedAt":"2018-07-13T16:25:15Z",
     "updatedBy":"joe@acme.com"
}]

ตั้งค่า $ACCESS_TOKEN เป็นโทเค็นเพื่อการเข้าถึง OAuth 2.0 ตามที่อธิบายไว้ในหัวข้อรับโทเค็นเพื่อการเข้าถึง OAuth 2.0

ดูข้อมูลเกี่ยวกับตัวเลือก cURL ที่ใช้ในตัวอย่างนี้ได้ที่ใช้ cURL

เพิ่ม uuid ของคอลเล็กชันต่อท้ายทรัพยากร /collections เพื่อดูคอลเล็กชันเฉพาะ ดังนี้

curl 'https://apimonitoring.enterprise.apigee.com/collections/1234abcd?org=myorg'
  -X GET
  -H 'Accept: application/json, text/plain, */*' 
  -H "Authorization: Bearer $ACCESS_TOKEN"