Anthos Multi-Cloud API: Node.js Client

release level npm version

Anthos Multi-Cloud API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Anthos Multi-Cloud API API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/gkemulticloud

Using the client library

 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 *  Required. The parent location which owns this collection of
 *  AwsCluster  resources.
 *  Location names are formatted as `projects/<project-id>/locations/<region>`.
 *  See Resource Names (
 *  for more details on GCP resource names.
// const parent = 'abc123'
 *  The maximum number of items to return.
 *  If not specified, a default value of 50 will be used by the service.
 *  Regardless of the pageSize value, the response can include a partial list
 *  and a caller should only rely on response's
 *  nextPageToken  to determine if
 *  there are more instances left to be queried.
// const pageSize = 1234
 *  The `nextPageToken` value returned from a previous
 *  awsClusters.list  request, if any.
// const pageToken = 'abc123'

// Imports the Gkemulticloud library
const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;

// Instantiates a client
const gkemulticloudClient = new AwsClustersClient({
  // API endpoint must be set:
  apiEndpoint: '',

async function callListAwsClusters() {
  // Construct request
  const request = {

  // Run request
  const iterable = await gkemulticloudClient.listAwsClustersAsync(request);
  for await (const response of iterable) {



Samples are in the samples/ directory. Each sample's has instructions for running its sample.

SampleSource CodeTry it
Attached_clusters.create_attached_clustersource codeOpen in Cloud Shell
Attached_clusters.delete_attached_clustersource codeOpen in Cloud Shell
Attached_clusters.generate_attached_cluster_agent_tokensource codeOpen in Cloud Shell
Attached_clusters.generate_attached_cluster_install_manifestsource codeOpen in Cloud Shell
Attached_clusters.get_attached_clustersource codeOpen in Cloud Shell
Attached_clusters.get_attached_server_configsource codeOpen in Cloud Shell
Attached_clusters.import_attached_clustersource codeOpen in Cloud Shell
Attached_clusters.list_attached_clusterssource codeOpen in Cloud Shell
Attached_clusters.update_attached_clustersource codeOpen in Cloud Shell
Aws_clusters.create_aws_clustersource codeOpen in Cloud Shell
Aws_clusters.create_aws_node_poolsource codeOpen in Cloud Shell
Aws_clusters.delete_aws_clustersource codeOpen in Cloud Shell
Aws_clusters.delete_aws_node_poolsource codeOpen in Cloud Shell
Aws_clusters.generate_aws_access_tokensource codeOpen in Cloud Shell
Aws_clusters.generate_aws_cluster_agent_tokensource codeOpen in Cloud Shell
Aws_clusters.get_aws_clustersource codeOpen in Cloud Shell
Aws_clusters.get_aws_json_web_keyssource codeOpen in Cloud Shell
Aws_clusters.get_aws_node_poolsource codeOpen in Cloud Shell
Aws_clusters.get_aws_open_id_configsource codeOpen in Cloud Shell
Aws_clusters.get_aws_server_configsource codeOpen in Cloud Shell
Aws_clusters.list_aws_clusterssource codeOpen in Cloud Shell
Aws_clusters.list_aws_node_poolssource codeOpen in Cloud Shell
Aws_clusters.rollback_aws_node_pool_updatesource codeOpen in Cloud Shell
Aws_clusters.update_aws_clustersource codeOpen in Cloud Shell
Aws_clusters.update_aws_node_poolsource codeOpen in Cloud Shell
Azure_clusters.create_azure_clientsource codeOpen in Cloud Shell
Azure_clusters.create_azure_clustersource codeOpen in Cloud Shell
Azure_clusters.create_azure_node_poolsource codeOpen in Cloud Shell
Azure_clusters.delete_azure_clientsource codeOpen in Cloud Shell
Azure_clusters.delete_azure_clustersource codeOpen in Cloud Shell
Azure_clusters.delete_azure_node_poolsource codeOpen in Cloud Shell
Azure_clusters.generate_azure_access_tokensource codeOpen in Cloud Shell
Azure_clusters.generate_azure_cluster_agent_tokensource codeOpen in Cloud Shell
Azure_clusters.get_azure_clientsource codeOpen in Cloud Shell
Azure_clusters.get_azure_clustersource codeOpen in Cloud Shell
Azure_clusters.get_azure_json_web_keyssource codeOpen in Cloud Shell
Azure_clusters.get_azure_node_poolsource codeOpen in Cloud Shell
Azure_clusters.get_azure_open_id_configsource codeOpen in Cloud Shell
Azure_clusters.get_azure_server_configsource codeOpen in Cloud Shell
Azure_clusters.list_azure_clientssource codeOpen in Cloud Shell
Azure_clusters.list_azure_clusterssource codeOpen in Cloud Shell
Azure_clusters.list_azure_node_poolssource codeOpen in Cloud Shell
Azure_clusters.update_azure_clustersource codeOpen in Cloud Shell
Azure_clusters.update_azure_node_poolsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Anthos Multi-Cloud API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/gkemulticloud@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.


Apache Version 2.0