登录到Data Infrastructure Insight并导航到*Admin > API Acccess*可以找到最新的API信息。单击 * API Documentation" 链接。

API文档基于Swagger、可提供API的简要说明和使用情况信息、并允许您在租户中试用。根据您的用户角色和/或Data Infrastructure Insight版本、您可以使用的API类型可能会有所不同。

在使用Data Infrastructure Insight API之前、您必须创建一个或多个*API访问令牌*。访问令牌用于指定的 API 类型，并且可以授予读取和 / 或写入权限。您还可以为每个访问令牌设置到期时间。指定类型下的所有 API 对访问令牌有效。每个令牌都不包含用户名或密码。

创建访问令牌：

您可以禁用，启用和撤消令牌。可以启用已禁用的令牌。

令牌从客户角度授予对 API 的通用访问权限；在其自己的租户范围内管理对 API 的访问权限。客户管理员可以授予和撤销这些令牌、而无需Data Infrastructure Insight后端人员的直接参与。

在用户成功进行身份验证并授权访问后，应用程序会收到访问令牌，然后在调用目标 API 时将访问令牌作为凭据传递。传递的令牌将通知 API 令牌的持有人已获得访问 API 的授权并执行授权期间授予的范围指定的特定操作。

传递访问令牌的 HTTP 标头为 * 。 X-CloudInsights ApiKey ： * 。

例如，使用以下命令检索存储资产：

有关特定于要使用的API的示例、请参见Swagger页面。

Data Infrastructure Insight API基于类别、当前包含以下类型：

其他类型和 / 或 API 可能会随着时间的推移而变为可用。您可以在中找到最新的API信息"API Swagger 文档"。

请注意、用户有权访问的API类型还取决于"用户角色"他们在每个Data Infrastructure Insight功能集中拥有的(监控、工作负载安全性、报告)。

本节介绍如何遍历Data Infrastructure Insight对象的层次结构。

许多 API 命令都支持 * 扩展 * 参数，该参数可提供有关相关对象的一个或多个 URL 的更多详细信息。

一个常见的扩展参数是 expands。响应包含对象的所有可用特定扩展的列表。

例如，当您请求以下内容时：

每个扩展都包含数据， URL 或这两者。expand 参数支持多个嵌套属性，例如：

要阻止这种情况，无法扩展对顶级收集的请求。例如，您不能同时请求所有存储对象的扩展数据。客户端需要检索对象列表，然后选择要扩展的特定对象。

性能数据会作为单独的示例收集到多个设备中。Data Infrastructure Insight会每小时汇总和汇总一次性能示例(默认值)。

通过 API ，可以访问样本和汇总数据。对于包含性能数据的对象，性能摘要可通过 expand=performal 的形式提供。性能历史记录时间序列可通过嵌套的 expand=performer.history 来查看。

性能数据对象示例包括：

性能指标具有问题描述 和类型，并包含一组性能摘要。例如，延迟，流量和速率。

性能摘要包含一个问题描述，单元，样本开始时间，样本结束时间以及一组汇总值（当前值，最小值，最大值，平均值等），这些值是从一个时间范围（ 1 小时， 24 小时， 3 天等）内的单个性能计数器计算得出的。

生成的性能数据词典具有以下关键字：

每个性能数据对象类型都有一组唯一的性能指标。例如，虚拟机性能对象支持使用 "diskThroughput " 作为性能指标。每个受支持的性能指标都属于指标词典中提供的特定 " 性能类别 " 。Data Infrastructure Insight支持本文档后面列出的多种性能指标类型。每个性能指标词典还将包含一个可供用户读取的此性能指标问题描述字段问题描述以及一组性能摘要计数器条目。

性能摘要计数器是性能计数器的汇总。它会显示计数器的典型聚合值，例如最小值，最大值和平均值，以及最新观察到的值，汇总数据的时间范围，计数器的单位类型以及数据的阈值。只有阈值是可选的；其余属性是必需的。

以下类型的计数器可提供性能摘要：

API可以返回租户上的对象的详细指标、例如：

有关每种对象类型的指标信息、请参见"API Swagger 文档"。

历史数据以时间戳和计数器映射对列表的形式显示在性能数据中。

历史计数器根据性能指标对象名称命名。例如，虚拟机性能对象支持 "diskThroughput " ，因此历史记录映射将包含名为 "diskThroughput ： read" ， "diskThroughput ： write" 和 "diskThroughput ： total" 的键。

以下是磁盘的性能数据 JSON 示例：

具有容量属性的对象使用基本数据类型和 CapacityItem 来表示。

搜索 API 是系统的一个简单入口点。API 的唯一输入参数是自由格式的字符串，生成的 JSON 包含分类结果列表。类型与清单不同，例如存储，主机，数据存储库等。每种类型都将包含一个与搜索条件匹配的对象列表。

Data Infrastructure Insight是一款可扩展(广泛开放)的解决方案、可与第三方业务流程、业务管理、变更控制和服务单系统以及自定义CMDB集成相集成。

Cloud Insight 的 RESTful API 是一个主要的集成点，支持简单有效地移动数据，并允许用户无缝访问其数据。

要临时禁用 API 令牌，请在 API 令牌列表页面上单击此 API 的 " 三点 " 菜单，然后选择 Disable 。您可以随时使用同一菜单并选择 Enable 来重新启用令牌。

要永久删除 API 令牌，请从菜单中选择 " 撤消 " 。您不能重新启用已撤销的令牌；您必须创建新令牌。

API 访问令牌具有到期日期。当 API 访问令牌过期时，用户需要生成一个新令牌（类型为 Data ingestion 且具有读 / 写权限），并重新配置 Telegraf 以使用新生成的令牌，而不是过期的令牌。以下步骤详细说明了如何执行此操作。