Estás viendo la documentación de Apigee Edge.
Ir a la
documentación de Apigee X. info
Las colecciones te permiten agrupar proxies de API, destinos o apps para desarrolladores, y configurar valores de umbral adecuados para todos los miembros del grupo para diagnosticar problemas más rápido.
En las siguientes secciones, se describe cómo administrar colecciones con la API.
Consulta la API de Collections para obtener más información sobre las colecciones de la API.
Crea colecciones con la API
Para crear una colección de proxies de API, envía una solicitud POST al siguiente recurso: https://apimonitoring.enterprise.apigee.com/collections
En el siguiente ejemplo, se muestra cómo crear una colección.
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"]
}'
Configura $ACCESS_TOKEN como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0.
Para obtener más información sobre las opciones cURL que se usaron en este ejemplo, consulta Usa cURL.
Puedes especificar el valor type como proxy, target o developerApp.
Por ejemplo, para crear una colección de apps para desarrolladores, haz lo siguiente:
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"]
}'
Visualiza todas las colecciones con la API
Para visualizar todas las alertas y notificaciones, envía una solicitud GET al siguiente recurso: https://apimonitoring.enterprise.apigee.com/collections
Debes pasar el nombre de tu organización con el parámetro de consulta org.
Por ejemplo:
curl 'https://apimonitoring.enterprise.apigee.com/collections?org=myorg' -X GET -H 'Accept: application/json, text/plain, */*' -H "Authorization: Bearer $ACCESS_TOKEN"
A continuación, se proporciona un ejemplo de la respuesta.
[{ "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" }]
Configura $ACCESS_TOKEN como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0.
Para obtener más información sobre las opciones cURL que se usaron en este ejemplo, consulta Usa cURL.
Agrega el uuid de la colección al recurso /collections para ver la colección específica:
curl 'https://apimonitoring.enterprise.apigee.com/collections/1234abcd?org=myorg' -X GET -H 'Accept: application/json, text/plain, */*' -H "Authorization: Bearer $ACCESS_TOKEN"