使用 API Monitoring Management API

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

使用 API Monitoring Management API 执行以下任务。

任务 更多信息
管理 API Monitoring 的提醒
管理 API Monitoring 的集合
查看不同级别的 API Monitoring 日志
查看 API Monitoring 指标

API 调用配额

所有 API Monitoring API 都会强制执行一个配额，以限制您每分钟可调用 API 的次数。例如，Create collections API 限制为每分钟只能调用六次。

并非所有 API 都有相同的配额限制。如需确定其限制，请参阅每个 API 的 API 参考文档。

使用 curl

本文档中的 API 示例使用 curl 演示如何使用 API 来使用 API Monitoring。curl 是一个开源命令行工具，用于通过网址语法传输数据，支持 HTTP 和 HTTPS 等常见协议。如需了解如何下载和使用 curl，请访问 https://curl.haxx.se/。

下表汇总了示例中使用的 curl 命令行选项。

选项 说明
-d '{}'

--data @filename

定义直接传递或通过指定文件名的请求正文。
-H

--header

定义请求标头。您必须在请求标头中传递以下信息：
  • 使用 Authorization 标头进行用户身份验证的 OAuth 2.0 令牌，如获取 OAuth 2.0 访问令牌中所述。
  • 客户端使用 Accept 标头支持的内容类型。
  • 使用 Content-Type 标头创建或更新资源（POST、PATCH、PUT）时发送的请求正文的内容类型。
-i 在响应中显示更多信息，例如标头。
-X 指定请求的类型（GET、POST 等）。

获取 OAuth 2.0 访问令牌

Apigee Edge 支持用于用户身份验证的 OAuth 2.0。借助 OAuth 2.0，您可以将 Apigee Edge 凭据交换为访问令牌和刷新令牌，以便用于安全地调用 Apigee Edge API。获取令牌后，在令牌失效之前，您不再需要交换凭据。刷新令牌可以让您的服务器“会话”在较长期间内保持活动状态，而无需提供凭据。有关访问令牌的更多信息，请参阅使用 OAuth2 访问 Management API。

借助 Apigee Edge 凭据，您可以使用 Apigee 的 get_token 实用程序获取 OAuth 2.0 访问权限，并使用刷新令牌来访问 Apigee Edge 资源。

如需获取 OAuth 2.0 访问令牌，请执行以下操作：

  1. 安装 get_token 实用程序：如需了解如何安装 get_token 实用程序，请参阅使用 get_token。

  2. 执行 get_token 以获取 OAuth 2.0 访问令牌。

    在您首次输入命令时，或者如果刷新令牌已过期，get_token 会提示您输入用户名、密码和 6 位数的双重身份验证代码。出现提示时，输入每个值。如果您未启用双重身份验证，则只需在提示时按 Enter 键即可。

  3. 复制 OAuth 2.0 令牌并将其存储在变量中，例如 ACCESS_TOKEN：

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

调用 API Monitoring API 时，使用 Authorization 标头在 HTTP 标头中传递 OAuth 2.0 访问令牌。例如：


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...