Administra colecciones con la API

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

Las colecciones te permiten agrupar proxies, objetivos o apps de desarrolladores de API y configurar valores de umbral adecuados para todos los miembros del grupo a fin de diagnosticar problemas más rápido.

En las siguientes secciones, se describe cómo administrar colecciones mediante la API.

Consulta API de Collection para obtener más información sobre esta API.

Crea colecciones con la API

Envía una solicitud POST al siguiente recurso para crear una colección de proxies de API: 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 de 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

Emitir una solicitud GET al siguiente recurso para ver todas las alertas y notificaciones: 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"