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

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

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

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับ Collections API ได้ที่ Collections 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"