本頁說明如何使用 API Explorer 試用 Dataproc Metastore API 方法。API Explorer 是附加至方法 REST API 參考頁面的小工具。這個面板的標題為「Try this API」(試試這個 API)。
API Explorer 是試用 Dataproc Metastore API 中方法的絕佳方式，無須編寫任何程式碼。小工具會透過表單來顯示每個方法的參數。填寫表單、按一下「執行」，即可看到結果。
你也可以按一下面板頂端的關閉按鈕來隱藏小工具，或按一下全螢幕按鈕將小工具展開為全螢幕。
事前準備
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Enable the Dataproc Metastore API.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Enable the Dataproc Metastore API.
- 請勿在任何類型的欄位值前後加上引號。
- 請務必為篩選器內的字串加上引號。請使用半形雙引號 (
")，而非撇號 (')。 - 請勿在表單欄位中使用反斜線或網址編碼。如有需要，執行方法時，系統會對欄位值進行網址編碼。
- 執行呼叫後，查看結果方塊中的值。您可能會發現問題。
- 為 pageSize 欄位提供值，例如
2。這項設定會限制您在偵錯 API 呼叫時傳回的資料量。
存取 API Explorer
API Explorer 會連結至每個 REST API 方法的參考資料頁面。如要尋找小工具，請前往方法的參考頁面，例如 Dataproc Metastore projects.locations.services.create 的參考頁面。
執行最少要求
大多數方法都有一些必要參數和一些選用參數。必填欄位會標上紅條，直到填寫完畢為止。您只需提供必要引數，即可執行最少量的要求。
services.create 方法會在所選專案和位置中建立 Dataproc Metastore 服務。必填欄位為 parent 和 serviceId 欄位。如要建立服務，請使用 projects/{projectNumber}/locations/{locationId} 格式，為 parent 提供專案的專案編號和位置 ID。並提供 serviceId 的服務 ID。
方法調用結果會顯示在「執行」按鈕下方的方塊中。通常，方塊會顯示綠色標題，並包含 HTTP 狀態碼 200，表示要求成功。
如果標題為紅色並包含 HTTP 失敗代碼，方塊中就會顯示錯誤訊息。請參閱「提示」，瞭解如何解決錯誤。
提供其他參數
您看到的參數清單取決於 API Explorer 小工具所附加的方法。services.create 方法不只有 parent 和 serviceId 參數，但這兩個是唯一必要的參數。
您可以選擇使用 requestId 參數指定不重複的要求 ID，讓伺服器在要求完成後忽略該要求。
使用欄位進一步限制輸出內容
根據預設，API Explorer 顯示的參數集會對應至相關聯方法的參數。不過，API Explorer 小工具也有一組額外欄位，無法透過方法本身使用。
這些參數會隱藏在「顯示標準參數」切換按鈕 下方。
按一下這個切換按鈕，即可顯示額外的 Widget 參數。按一下「隱藏標準參數」，即可隱藏這些參數。
在這些標準參數中，最實用的是 fields 參數，可讓您選取要顯示的傳回輸出內容欄位。這在 API Explorer 面板中非常實用，因為輸出內容會顯示在方塊中。通常需要捲動才能看完所有輸出內容。
提示
以下各節提供 API Explorer 提示。
記得變更 {projectNumber} and {locationId}
請記得將 {projectNumber} and {locationId} 替換為專案編號和位置 ID。請注意，API 也接受專案 ID，而非編號。
值有問題
使用 API 探索工具表單時，請注意下列問題。這些錯誤可能會導致錯誤，或遭系統接受但視為 API 方法中的拼字錯誤：
用於偵錯的書籤網址
取得您要的輸出後，請將 API Explorer 網址加入書籤。如要再次執行該方法，請將網址貼到瀏覽器。您會看到表單已填入您的值。視需要變更參數，然後按一下「Execute」再次執行方法。
驗證
API Explorer 頁面上的「Execute」(執行) 按鈕上方，有一個「Credentials」(憑證) 區段。通常不需要變更任何設定。
預設驗證機制為 Google OAuth 2.0。
「憑證」部分中也有「顯示範圍」切換按鈕。這會顯示您可用的 Compute Engine 範圍。根據預設，系統會啟用所有可用範圍。