本文解释了如何使用 GraphQL Playground 运行一些示例查询并测试连接到 Cato Networks API 端点。
GraphQL Playground 允许您运行直接发送到 Cato API 服务器的 API 查询。 第三方 API 查询软件如 Altair 或 Postman，提供强大的功能用于运行 API 调用。 然而，如果 API 查询存在连接问题，您可以使用 Playground 来帮助识别问题的原因。
要从 GraphQL Playground 运行 Cato API 查询，您必须拥有您账户的 API 密钥（资源 > API 密钥）。 有关 API 密钥的更多信息，请参见 生成 Cato API 的 API 密钥。
您需要在示例查询中输入您账户的 Cato 管理应用程序 (CMA) ID。 您可以在账户信息页面找到 CMA ID。
API端点的 URL 是根据托管 Cato 管理应用程序 (CMA) 实例的位置而特定的。 可能存在一个<prefix>值，该值附加到您的CMA账户的URL和API端点。
-
如果没有前缀（
cc.catonetworks.com），则使用以下 URL：https://api.catonetworks.com/api/v1/graphql2 -
如果有一个前缀（如
cc.us1.catonetworks.com），那么您将使用以下 URL：https://api.us1.catonetworks.com/api/v1/graphql2
您可以运行一个示例 API 查询以测试与 Cato API 服务器的连接性。 当 accountID 参数和 API 密钥配置正确时，示例 API 查询会返回账户数据，并在 GraphQL Playground 中显示结果。 如果查询未返回您账户的结果，则可能与 API 服务器的连接性存在问题，或者服务器可能已停机。 以下示例 API 查询可以帮助您测试连接到 Cato API 服务器的连接性：
使用互联网浏览器打开 Cato API 的 GraphQL Playground。 用您的 API 密钥配置 Playground 的超文本传输协议头。 将示例查询粘贴到左侧窗格中并输入您的账户ID。 然后您可以运行查询并在Playground中查看结果。
-
从本文下载其中一个示例 API 查询，并在记事本等文本编辑器中打开文件。
-
从互联网浏览器进入 Cato API 的 GraphQL Playground。
-
在左侧窗格的底部，点击 HTTP 头文件。
-
以这样的格式输入您的 API 密钥：
{ "x-api-key" :"<api key>" }。以下截图展示了用 API 密钥AaBbCcDdEeFf0123456789ABCDEF1234配置的 HTTP 头文件：
-
将一个示例查询复制并粘贴到Playground的左侧窗格中。
-
在查询的顶部，在
accountID参数中输入您的账户 ID。以下截图显示已配置为值 2626 的
accountID参数： -
点击播放按钮。
-
右侧窗格显示 API 查询的结果。 以下截图显示账户 ID 2626 的示例 accountMetrics 查询结果：
0 条评论
请登录写评论。