Instana API 以及 SDK

在线编辑

Instana API 可帮助您将 Instana 监控和可观测性平台集成到您的应用程序中。

如需了解更多信息，请参阅 Instana REST API 文档以及 Instana GraphQL 文档。

先决条件

在线编辑

开始之前，请确保您对 RESTful API、 GraphQL, HTTP 协议以及 Instana 账户有基本的了解。

生成用于身份验证的 API 令牌

在线编辑

要对发送到 Instana API 的请求进行身份验证，您需要一个 API 令牌。 请按照以下步骤生成您的 API 令牌：

  1. 登录您的 Instana 账户。
  2. 在 Instana 用户界面的导航菜单中，单击 “设置”。
  3. 在 “安全与访问 ”选项卡的 “访问控制 ”部分，单击“ API 令牌 ”。
  4. 为您的令牌输入名称，并设置相应的权限。
  5. 生成 API 令牌后，请复制您的 API 令牌，并将其妥善保管以备后用。

发出请求

在线编辑

Instana REST API 和 GraphQL API 均采用标准的 HTTP 方法。 基础 URL 对于每个 Instana 实例都是唯一的，它源自您的租户和单元，并且与您用于访问 Instana 用户界面的 URL 相同。

请使用您的 API 令牌对每次请求进行身份验证。

  • 基本 URL： https://<TENANT>-<UNIT>.instana.io/api
  • 授权：请使用 方案， Bearer 在 Authorization 标头中包含您的 API 令牌。
以下示例展示了一个使用 curl 的请求：
curl -X GET https://<TENANT>-<UNIT>.instana.io/api/<INSTANA_REST_API_ENDPOINT> \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
对于 GraphQL 的查询，所有请求都会发送到同一个 URL ：
POST https://<your-instana-host>/api/graphql

my-company.instana.io请将 替换 <your-instana-host> 为您的 Instana 租户主机名（例如，）。

每个请求都是一个 HTTPPOST ，其 JSON 主体中包含您要执行的查询。

API 端点

在线编辑

API 端点是指一个特定的 URL ，用于接收针对特定操作的请求。 Instana 提供了用于查询监控数据、配置告警以及管理自定义事件的端点。

有关 Instana REST API 及其各端点的使用详情（包括请求参数、响应格式和请求示例），请参阅 Instana REST API 文档。

GraphQL 查询有一个单一的端点，即 `api/graphql`。有关 GraphQL 查询的更多信息，请参阅 Instana GraphQL 文档。

费率限制

在线编辑

您必须始终查看 Instana API的调用限制。 这些限制有助于确保所有用户的服务可用性和性能。 如需了解更多信息，请参阅 Instana REST API 速率限制。