使用 API Explorer

本页面介绍了如何使用 API Explorer 尝试 Dataproc Metastore API 方法。API Explorer 是附加到方法的 REST API 参考页面的微件。它会显示为一个面板,标题为试用此 API

API Explorer 是在 Dataproc Metastore API 中试用方法的绝佳方法,无需编写任何代码。该微件会显示一个表单,其中显示每种方法的参数。填写表单,点击执行按钮,然后查看结果。

您还可以通过点击面板顶部的关闭按钮来隐藏微件,或通过点击全屏按钮将其展开到全屏。

准备工作

访问 API Explorer

API Explorer 会附加到每种 REST API 方法的参考页面。要查找微件,请转到方法的参考页面,例如 Dataproc Metastore projects.locations.services.create 的参考页面

执行最小请求

大多数方法都有一些必需参数和一些可选参数。系统会用红色条标记必填项,直到填充完毕。您只需提供必需参数即可执行最小请求。

services.create 方法会在所选项目和位置创建 Dataproc Metastore 服务。必填字段为 parentserviceId 字段。要创建服务,请使用 projects/{projectNumber}/locations/{locationId} 形式提供您项目的项目编号和位置 ID 作为 parent。并提供服务 ID 作为 serviceId

试试看!

方法调用的结果显示在执行按钮下方的框中。通常,该框会包含一个绿色标头,其中包含 HTTP 状态代码 200,表示请求成功。

如果标头为红色且包含 HTTP 失败代码,则该框中包含错误消息。请参阅下面的提示,了解有关解决错误的一些提示。

提供其他参数

您看到的参数列表取决于 API Explorer 微件的附加方法。services.create 方法不仅仅只有 parentserviceId 参数,但它们是唯一的必需参数。

您可以使用可选的 requestId 参数指定唯一请求 ID,以允许服务器在请求完成后忽略该请求。

使用字段进一步限制输出

默认情况下,API Explorer 显示的参数集与关联方法的参数相对应。但是,API Explorer 微件还具有一组额外字段,这些字段无法通过方法本身使用。

这些参数隐藏在显示标准参数 (Show standard parameters) 切换开关下。

点击此切换开关可显示其他微件参数。点击隐藏标准参数可隐藏这些参数。

这些标准参数中最有用的是 fields 参数,您可以在返回的输出中选择要查看的字段。这在 API Explorer 面板中非常有用,其中输出显示在框中。通常需要滚动浏览大量输出。

提示

记住更改 {projectNumber} and {locationId}

请记得将 {projectNumber} and {locationId} 替换为您的项目编号和位置 ID。请注意,该 API 也支持使用项目 ID 代替编号。

值问题

以下是使用 API Explorer 表单时需要注意的一些问题。这些错误可能会导致错误或被接受,但可能会被视为 API 方法中的拼写错误:

  • 请勿在任何类型的字段值前后加上引号。
  • 请务必用英文引号括住过滤器内的字符串。请使用英文双引号 ("),不要使用撇号 (')。
  • 请勿在表单字段中使用反斜杠或网址编码。如果需要,在执行方法时对字段值执行网址编码。
  • 在执行调用后查看结果框中的值。您可能会在此处发现问题。
  • 您可能希望为 pageSize 字段提供一个值,例如 2。这限制了在您调试 API 调用时返回的数据量。

用于调试的书签网址

获得所需的输出后,将 API Explorer 网址添加为书签。如果想要再次运行该方法,请将网址粘贴到浏览器中。您会看到表单已填入您的值。对参数进行必要的更改,然后点击执行以再次运行该方法。

身份验证

在 API Explorer 页面的执行按钮上方有一个凭据部分。您通常不需要更改此处的内容。

默认身份验证机制为 Google OAuth 2.0

凭据部分中还有一个显示范围切换开关。这将显示您可用的 Compute Engine 范围。默认情况下,系统会启用所有可用范围。

后续步骤