本文解释了如何使用 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 账户和 API 端点的 URL。
-
如果没有前缀 (
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 的 HTTP 头。 将示例查询粘贴到左侧窗格并输入您的账户 ID。 然后，您可以运行查询并在 Playground 中查看结果。
-
从本文下载一个示例 API 查询并在诸如 Notepad 的文本编辑器中打开文件。
-
从互联网浏览器转到 Cato API 的 GraphQL Playground。
-
在左侧窗格的底部，点击 HTTP 头。
-
以此格式输入您的 API 密钥：
{ "x-api-key" :"<api key>" }。下方截图显示了使用 API 密钥和AaBbCcDdEeFf0123456789ABCDEF1234配置的 HTTP 头：
-
将一个示例查询复制并粘贴到 Playground 的左侧窗格。
-
在查询顶部的
accountID参数中输入您的账户 ID。下方截图显示配置账户 ID 参数的值为 2626：
-
点击播放按钮。
-
右侧窗格显示了 API 查询的结果。 下方截图展示了为账户 ID 2626 提供的 accountMetrics 示例查询结果：
0 条评论
请登录写评论。