Mengelola koleksi menggunakan API

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Koleksi memungkinkan Anda mengelompokkan proxy API, target, atau aplikasi developer dan menyiapkan nilai minimum yang sesuai untuk semua anggota grup guna mendiagnosis masalah dengan lebih cepat.

Bagian berikut menjelaskan cara mengelola koleksi menggunakan API.

Lihat Collections API untuk mengetahui informasi selengkapnya tentang Collections API.

Membuat koleksi menggunakan API

Buat kumpulan proxy API dengan mengirimkan permintaan POST ke resource berikut: https://apimonitoring.enterprise.apigee.com/collections

Contoh berikut menunjukkan cara membuat koleksi.

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"]
    }'

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0.

Untuk mengetahui informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.

Anda dapat menentukan nilai type sebagai proxy, target, atau developerApp. Misalnya, untuk membuat koleksi aplikasi developer:

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"]
    }'

Melihat semua koleksi menggunakan API

Lihat semua notifikasi dan pemberitahuan dengan mengirimkan permintaan GET ke resource berikut: https://apimonitoring.enterprise.apigee.com/collections

Anda harus meneruskan nama organisasi menggunakan parameter kueri org.

Contoh:

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

Berikut adalah contoh respons:

[{
     "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"
}]

Tetapkan $ACCESS_TOKEN ke token akses OAuth 2.0 Anda, seperti yang dijelaskan dalam Mendapatkan token akses OAuth 2.0.

Untuk mengetahui informasi tentang opsi cURL yang digunakan dalam contoh ini, lihat Menggunakan cURL.

Tambahkan uuid koleksi ke resource /collections untuk melihat koleksi tertentu:

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