使用 API 管理集合

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

借助集合,您可以对 API 代理、目标或开发者应用进行分组,并为该群组的所有成员设置适当的阈值,以更快地诊断问题。

以下部分介绍了如何使用 API 管理集合。

如需详细了解 Collections API,请参阅 Collections API

使用 API 创建集合

通过向以下资源发出 POST 请求来创建 API 代理集合: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"]
    }'

按照获取 OAuth 2.0 访问令牌中的说明,将 $ACCESS_TOKEN 设置为您的 OAuth 2.0 访问令牌。

如需了解此示例中使用的 cURL 选项,请参阅使用 cURL

您可以将 type 值指定为 proxytargetdeveloperApp。例如,如需创建开发者应用集合,请使用以下代码:

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

按照获取 OAuth 2.0 访问令牌中的说明,将 $ACCESS_TOKEN 设置为您的 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"