arrow_back

APIs Explorer: Create and Update a Cluster

Join Sign in

APIs Explorer: Create and Update a Cluster

1 hour 1 Credit

GSP288

Google Cloud self-paced labs logo

Overview

The Google APIs Explorer is a tool that helps you explore various Google APIs interactively. With the APIs Explorer, you can:

  • Browse quickly through available APIs and versions.
  • See methods available for each API and what parameters they support along with inline documentation.
  • Execute requests for any method and see responses in real time.
  • Make authenticated and authorized API calls.
  • Search across all services, methods, and your recent requests to quickly find what you are looking for.

The APIs Explorer uses its own API key whenever it makes a request. When you use the APIs Explorer to make a request, it displays the request syntax, which includes a placeholder labeled {YOUR_API_KEY}. If you want to make the same request in your application, you need to replace this placeholder with your own API key.

In this lab you'll learn how to use an inline Google APIs Explorer template to call the Cloud Dataproc API to create a cluster, then run a simple Spark job in the cluster. It also shows you how to use the APIs Explorer template to call the Cloud Dataproc API to update a cluster.

Setup

Before you click the Start Lab button

Read these instructions. Labs are timed and you cannot pause them. The timer, which starts when you click Start Lab, shows how long Google Cloud resources will be made available to you.

This hands-on lab lets you do the lab activities yourself in a real cloud environment, not in a simulation or demo environment. It does so by giving you new, temporary credentials that you use to sign in and access Google Cloud for the duration of the lab.

To complete this lab, you need:

  • Access to a standard internet browser (Chrome browser recommended).
Note: Use an Incognito or private browser window to run this lab. This prevents any conflicts between your personal account and the Student account, which may cause extra charges incurred to your personal account.
  • Time to complete the lab---remember, once you start, you cannot pause a lab.
Note: If you already have your own personal Google Cloud account or project, do not use it for this lab to avoid extra charges to your account.

How to start your lab and sign in to the Google Cloud Console

  1. Click the Start Lab button. If you need to pay for the lab, a pop-up opens for you to select your payment method. On the left is the Lab Details panel with the following:

    • The Open Google Console button
    • Time remaining
    • The temporary credentials that you must use for this lab
    • Other information, if needed, to step through this lab
  2. Click Open Google Console. The lab spins up resources, and then opens another tab that shows the Sign in page.

    Tip: Arrange the tabs in separate windows, side-by-side.

    Note: If you see the Choose an account dialog, click Use Another Account.
  3. If necessary, copy the Username from the Lab Details panel and paste it into the Sign in dialog. Click Next.

  4. Copy the Password from the Lab Details panel and paste it into the Welcome dialog. Click Next.

    Important: You must use the credentials from the left panel. Do not use your Google Cloud Skills Boost credentials. Note: Using your own Google Cloud account for this lab may incur extra charges.
  5. Click through the subsequent pages:

    • Accept the terms and conditions.
    • Do not add recovery options or two-factor authentication (because this is a temporary account).
    • Do not sign up for free trials.

After a few moments, the Cloud Console opens in this tab.

Note: You can view the menu with a list of Google Cloud Products and Services by clicking the Navigation menu at the top-left. Navigation menu icon

Activate Cloud Shell

Cloud Shell is a virtual machine that is loaded with development tools. It offers a persistent 5GB home directory and runs on the Google Cloud. Cloud Shell provides command-line access to your Google Cloud resources.

  1. Click Activate Cloud Shell Activate Cloud Shell icon at the top of the Google Cloud console.

  2. Click Continue.

It takes a few moments to provision and connect to the environment. When you are connected, you are already authenticated, and the project is set to your PROJECT_ID. The output contains a line that declares the PROJECT_ID for this session:

Your Cloud Platform project in this session is set to YOUR_PROJECT_ID

gcloud is the command-line tool for Google Cloud. It comes pre-installed on Cloud Shell and supports tab-completion.

  1. (Optional) You can list the active account name with this command:

gcloud auth list

Output:

ACTIVE: * ACCOUNT: student-01-xxxxxxxxxxxx@qwiklabs.net To set the active account, run: $ gcloud config set account `ACCOUNT`
  1. (Optional) You can list the project ID with this command:

gcloud config list project

Output:

[core] project = <project_ID>

Example output:

[core] project = qwiklabs-gcp-44776a13dea667a6 Note: For full documentation of gcloud, in Google Cloud, refer to the gcloud CLI overview guide.

Open APIs Explorer

Go to Navigation menu > APIs & Services.

Scroll down the list until you find Cloud Dataproc API, and click on it.

Make sure that API is enabled, if not click Enable. Now that you have verified the API's enablement, open Rest API Reference. This will open a new tab with the Rest API Reference page for the Cloud Dataproc API.

Create a Cluster

From the left APIs & Reference section navigate to REST reference > v1 > projects.regions.clusters > create to projects.regions.clusters.create method or use this link to create cluster.

Now you'll fill in the form and execute the APIs Explorer template, below, as follows:

  1. Insert your Qwiklabs Project ID in the projectId field.

  2. Set the region field to us-central1.

  3. In the Request body, click between the curly brackets and add the clusterName property. Enter the clusterName of your choice. Note, the value of the clusterName must not contain any uppercase letters or spaces.

  4. From the Add a Property dropdown menu choose config.

  5. In the Add a Property dropdown, choose gceClusterConfig.

  6. In this Add a Property dropdown choose zoneUri field, then add the following, replacing my-project-id with the Project ID for this lab:

https://www.googleapis.com/compute/v1/projects/my-project-id/zones/us-central1-a
  1. In the curly bracket under config, select softwareConfig
  2. In the curly bracket under softwareConfig, select imageVersionand set it to 2.0-debian10
  3. In the curly bracket under softwareConfig, select optionalComponents. Under optionalComponents click on ADD ITEM and select JUPYTER from the dropdown.

When you're done your Request body should look like this:

create-cluster.png

Make sure that Google OAuth 2.0 and API key checkboxes are selected under Credentials section.

9cd35216d4029145.png

Note: To view Credentials FAQs, click on question mark icon next to Credentials title.

Make sure that there are no trailing spaces in any of the fields.

Now scroll down and click Execute.

Select the student account you started the lab with.

On the next screen, click Allow to give APIs Explorer access.

The results of the Dataproc API will appear below the Request and will look similar to the following:

cluster-created-response.png

You can go to Navigation menu > Dataproc > Clusters to see the custer created.

cluster-created.png

Test Completed Task

Click Check my progress to verify your performed task. If you successfully created a Dataproc cluster in the us-central1 region, you will see an assessment score.

Create a Dataproc cluster (region: us-central1)

Run a Spark job

Next you'll run a simple Apache Spark job that calculates a rough value for pi in an existing Cloud Dataproc cluster.

From the left APIs & Reference section navigate to REST reference > v1 > projects.regions.jobs > submit to projects.regions.jobs.submit method or use this link to submit a job to a cluster.

Now you'll fill in the form and execute the APIs Explorer template, below, as follows:

  1. Insert your project ID in the projectId field.

  2. Set the region field to us-central1.

  3. In the Request body, click between the curly brackets and choose job.

  4. Click in the curly brackets below this and choose placement.

  5. Click in the curly brackets below this and choose clusterName then type the name of your cluster.

  6. In the curly bracket under job, select sparkJob.

  7. You will now add 3 items under sparkJob:

  • In the curly bracket under sparkjob, select args. Under args click on ADD ITEM and type 1000
  • In the Add a Property dropdown, choose jarFileUris. Under jarFileUris click on ADD ITEM and type file:///usr/lib/spark/examples/jars/spark-examples.jar
  • In the Add a Property dropdown, choose mainClass and type org.apache.spark.examples.SparkPi

When you're done your Request body should look like this:

spark-job.png

Make sure that Google OAuth 2.0 and API key checkboxes are selected under Credentials section.

9cd35216d4029145.png

Note: To view Credentials FAQs, click on question mark icon next to Credentials title.

Make sure that there are no trailing spaces in any of the fields. Click EXECUTE.

The results of the Dataproc API will appear below the Request, and look similar to this:

spark-job-response.png

You can find your results by going to Dataproc > Clusters. Click on the name of your cluster, then the Jobs tab.

Click on the Job ID and select Line Wrap to ON to bring the lines that exceed the right margin into view.

submit-job-response.png

Test Completed Task

Click Check my progress to verify your performed task. If you successfully submit a Spark job to a cluster, you will see an assessment score.

Submit a Spark Job

Update a cluster

From the left APIs & Reference section navigate to REST reference > v1 > projects.regions.clusters > patch to projects.regions.clusters.patch method or use this link to update a cluster.

Now you'll fill in the form and execute the APIs Explorer template, below, as follows:

  1. projectID = your project ID

  2. Region = us-central1

  3. clusterName = enter your cluster name

  4. updateMask = config.worker_config.num_instances

  5. Patch body, enter the following:

  • First curly bracket = config
  • Click in the curly bracket below this and choose workerConfig
  • Click in the curly bracket beneath this, and select numInstances , then type in 3.

Your form should look like this:

update-cluster-2.png

Make sure that Google OAuth 2.0 and API key checkboxes are selected under Credentials section.

9cd35216d4029145.png

Note: To view Credentials FAQs, click on question mark icon next to Credentials title.

Make sure that there are no trailing spaces in any of the fields. Click EXECUTE.

The results of the Dataproc API will appear below the Request, and look similar to this:

update-nodes.png

To verify this update, go back to the Dataproc Clusters page. You'll see that you now have 3 total worker nodes.

update-workers.png

Test Completed Task

Click Check my progress to verify your performed task. If you have successfully update a worker config for 3 worker nodes you will see an assessment score.

Update a cluster for 3 worker nodes

Test your Understanding

Below are a multiple choice questions to reinforce your understanding of this lab's concepts. Answer them to the best of your abilities.

Congratulations!

You have used the Cloud Dataproc API through the API Explorer to create a cluster and run a Spark job, and update a cluster.

Finish Your Quest

API_Ex_badge.png

This self-paced lab is part of the Qwiklabs Exploring APIs Quest. A Quest is a series of related labs that form a learning path. Completing this Quest earns you the badge above, to recognize your achievement. You can make your badge (or badges) public and link to them in your online resume or social media account. Enroll in this Quest and get immediate completion credit if you've taken this lab. See other available Qwiklabs Quests.

Next Steps / Learn More

Google Cloud training and certification

...helps you make the most of Google Cloud technologies. Our classes include technical skills and best practices to help you get up to speed quickly and continue your learning journey. We offer fundamental to advanced level training, with on-demand, live, and virtual options to suit your busy schedule. Certifications help you validate and prove your skill and expertise in Google Cloud technologies.

Manual Last Updated March 01, 2021
Lab Last Tested March 01, 2021

Copyright 2022 Google LLC All rights reserved. Google and the Google logo are trademarks of Google LLC. All other company and product names may be trademarks of the respective companies with which they are associated.