排查 API 使用问题

本页面简要介绍了应用开发者如何排查其 Google API 和 Google Cloud API 使用的问题。

背景

Google API 是 Google 服务提供的联网 API。应用可以通过 JSON HTTP 和 gRPC 从不同环境中访问 Google API。我们建议开发者在其应用中使用 Google 提供的客户端库。这些库实现了常见的样板逻辑（例如身份验证和列表分页），从而大幅减少了开发费用和常见错误。

如需了解详情，请参阅客户端库说明

使用入门

如果您是 Google API 新手，则应按照使用入门页面中的说明完成应用的准备步骤。您应先使用 curl -v 命令向要使用的 Google API 发送测试请求。它可让您在不编写任何代码的情况下试用 Google API。在开始进行实际应用开发之前，您通常可以解决许多问题。

如需了解详情，请参阅使用入门。

使用指标进行问题排查

Google API 提供免费的 API 指标，涵盖 API 使用情况的常见方面，包括请求数、错误、延迟、请求和响应大小。这些指标会针对应用和位置提供精细的维度信息。开发者可以发现异常的 API 使用情况，并确定潜在的根本原因。例如，错误代码高于 400 可能表示最近更新的应用遇到了一些逻辑错误，而较高的请求和响应大小可能会导致应用性能降低。

如需了解详情，请参阅监控 API 使用量。

使用日志进行问题排查

出于安全和隐私原因，Google API 通常不会向应用开发者提供 API 日志。我们强烈建议应用开发者在客户端记录 API 错误。您可以将错误记录到本地存储空间或远程日志记录 API（如 Cloud Logging API）。

比起指标信息，日志通常包含更多错误信息，例如错误消息和错误详情。这些信息十分有用，对于排查 API 错误必不可少。如果开发者发现有关 API 使用的任何问题，可以查询日志以查找错误消息和错误详情，并使用这些信息来解决错误或与支持团队联系。

Cloud Audit Logs

对于涉及安全问题的敏感活动，Google Cloud 产品可能会生成包含活动详细信息的审核日志。这些日志是排查 Google Cloud API 使用问题的重要信息来源。例如，VPC Service Controls 试运行功能会生成审核日志，以便管理员评估即将发生的政策更改。

如需了解详情，请参阅 Cloud Audit Logs。

解决错误

如果您在使用 Google API 时遇到问题，并且已找到相应的指标和日志，则可以按照 API 设计指南错误页面中的说明来解决这些错误。

一般来说，每个 API 错误都包含 3 项信息：错误代码、错误消息和错误详情：

  • 通过错误代码，应用可以处理更高级别的错误，例如，在处理 503 错误后重试，或在处理 401 错误后重新验证用户的身份。

  • 通过错误消息，应用开发者可以理解错误并修复应用逻辑。

  • 错误详情包含可供应用以编程方式处理错误的其他信息。

如需了解详情，请参阅错误页面。