概述

Aura API 允许您以编程方式对 Aura 实例执行操作,而无需登录控制台。

可以在 API 规范 中查看和测试可用端点的完整列表。

在使用 API 之前,您必须按照 身份验证 中概述的步骤创建您的凭据并验证您的请求。

API URL

基本 URL

Aura API 的基本 URL 为 https://api.neo4j.io

版本控制

Aura API 的当前版本为 v1

当我们需要对 API 引入重大更改时,我们将发布新版本以确保我们不会破坏现有的集成。

将来,当我们弃用旧版 API 时,我们将提供通知。一旦弃用版本的过期日期过去,该版本将不再可用。

请求示例

以下示例显示了如何使用基本 URL 和版本控制向 API 发出请求

GET https://api.neo4j.io/v1/instances

重试

如果出现 5xx 服务器错误响应,如果您认为安全,可以考虑延迟后重试请求。响应可能包含一个 Retry-After 标头,其中包含建议在尝试重试之前合适的最小延迟。

速率限制设置为每分钟 125 个请求。

在尝试重试之前,您应该考虑您对速率限制的使用,我们建议使用指数退避延迟和有限次数的重试,然后再放弃。

仅当请求使用幂等的 HTTP 方法(例如 GET)时,才能保证请求可以安全地重试。例如,如果您重试创建实例的请求,您可能会创建重复的实例,并因此被额外收费。

如果出现 429 Too Many Requests,我们建议降低客户端应用程序发送的所有请求的速率,并考虑使用合适的最小延迟和退避策略进行重试。

对于其他 4xx 客户端错误响应,您不应在未先更正它们的情况下重新发送此类请求。

请求跟踪和故障排除

每个请求都会返回一个 X-Request-Id 响应标头,可用于故障排除。

此标头的值包含一个唯一 ID,可用于跟踪请求的流程。

如果您遇到任何特定请求的问题,您可以 提交支持工单 并提供 X-Request-Id