本文解释了如何使用GraphQL Playground运行一些示例查询并测试到Cato Networks API服务器的连接性。

GraphQL Playground概览

GraphQL Playground让您可以运行直接发送到Cato API服务器的API查询。 第三方API查询软件（如Altair或Postman）提供强大的功能来运行API调用。 但是，如果API查询存在连接性问题，您可以使用Playground帮助识别问题的原因。

使用GraphQL Playground进行Cato API查询的先决条件

要从GraphQL Playground运行Cato API查询，您必须拥有您账户的API密钥（管理 > API & 集成）。 有关API密钥的更多信息，请参见生成Cato API的API密钥。

示例查询还要求您输入该账户的 Cato 管理应用程序 ID。 此账户 ID 不会显示在 Cato 管理应用程序中，而是 URL 中的编号。 例如，以下 URL 的账户 ID 是 26： https://cc.catonetworks.com/#!/26/topology。

使用示例Cato API查询进行连接性测试

您可以运行示例API查询以测试到Cato API服务器的连接性。 当账户ID参数和API密钥配置正确时，示例API查询将返回账户数据并在GraphQL Playground中显示结果。

如果查询没有返回您账户的结果，那么可能存在到API服务器的连接性问题或服务器可能已关闭。

以下示例API查询可以帮助您测试到Cato API服务器的连接性：

• accountMetrics
• accountSnapshot

有关Cato API问题故障排除的更多信息，请参见Cato API调用故障排除。

在GraphQL Playground中运行示例API查询

使用互联网浏览器打开Cato API的GraphQL Playground。 使用您的API密钥配置Playground的HTTP头。 将示例查询粘贴到左窗格中并输入您的账户 ID。 然后，您可以运行该查询并在 Playground 中查看结果。

要运行示例API查询：

1. 从本文中下载一个示例API查询，并在文本编辑器（如记事本）中打开文件。
2. 从互联网浏览器中，前往Cato API的GraphQL Playground：https://api.catonetworks.com/api/v1/graphql2。
3. 在左窗格底部，点击HTTP HEADERS。
4. 按以下格式输入您的API密钥：{ "x-api-key" :"<api key>" }。

   以下截图显示了配置了API密钥AaBbCcDdEeFf0123456789ABCDEF1234后的HTTP头：

   

5. 将其中一个示例查询复制并粘贴到 Playground 的左窗格中。
6. 在查询顶部的 id 参数中输入您的账户 ID。

   以下截图显示了ID参数已配置为值2626：

   

7. 点击播放按钮。

   右窗格显示API查询的结果。 以下截图显示了账户ID为2626的示例accountMetrics查询的结果：