Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
As coleções permitem agrupar proxies, destinos ou apps do desenvolvedor de API e configurar valores de limites adequados para todos os membros do grupo para diagnosticar problemas mais rapidamente.
As seções a seguir descrevem como gerenciar coleções usando a API.
Consulte API Collections para mais informações sobre a API collections.
Criar coleções usando a API
Crie uma coleção de proxies de API emitindo uma solicitação POST para o seguinte
recurso: https://apimonitoring.enterprise.apigee.com/collections
O exemplo a seguir mostra como criar uma coleção.
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"]
}'
Defina $ACCESS_TOKEN como token de acesso do OAuth 2.0, conforme descrito em Receber um token de acesso do OAuth 2.0.
Para informações sobre as opções de cURL usadas neste exemplo, consulte Usar cURL (em inglês).
É possível especificar o valor de type como proxy, target ou developerApp.
Por exemplo, para criar uma coleção de apps de desenvolvedor:
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"]
}'
Mostrar todas as coleções usando a API
Veja todos os alertas e notificações enviando uma solicitação GET para o seguinte recurso: https://apimonitoring.enterprise.apigee.com/collections
Você precisa passar o nome da organização usando o parâmetro de consulta org.
Exemplo:
curl 'https://apimonitoring.enterprise.apigee.com/collections?org=myorg' -X GET -H 'Accept: application/json, text/plain, */*' -H "Authorization: Bearer $ACCESS_TOKEN"
Confira a seguir um exemplo de resposta:
[{
"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"
}]
Defina $ACCESS_TOKEN como token de acesso do OAuth 2.0, conforme descrito em Receber um token de acesso do OAuth 2.0.
Para informações sobre as opções de cURL usadas neste exemplo, consulte Usar cURL (em inglês).
Anexe o uuid da coleção ao recurso /collections para visualizar a
coleção 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"