Method: projects.instances.create

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serveNodes is set to non-zero, then the cluster is manually scaled. If clusterConfig.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

HTTP request

POST https://bigtableadmin.googleapis.com/v2/{parent=projects/*}/instances

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The unique name of the project in which to create the new instance. Values are of the formprojects/{project}.

Authorization requires one or more of the followingIAM permissions on the specified resourceparent:

  • bigtable.instances.create
  • bigtable.clusters.create

Request body

The request body contains data with the following structure:

JSON representation
{"instanceId":string,"instance":{object (Instance)},"clusters":{string:{object (Cluster)},...}}
Fields
instanceId

string

Required. The ID to be used when referring to the new instance within its project, e.g., justmyinstance rather thanprojects/myproject/instances/myinstance.

instance

object (Instance)

Required. The instance to create. Fields markedOutputOnly must be left blank.

clusters

map (key: string, value: object (Cluster))

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., justmycluster rather thanprojects/myproject/instances/myinstance/clusters/mycluster. Fields markedOutputOnly must be left blank.

An object containing a list of"key": value pairs. Example:{ "name": "wrench", "mass": "1.3kg", "count": "3" }.

Response body

If successful, the response body contains a newly created instance ofOperation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.admin
  • https://www.googleapis.com/auth/bigtable.admin.cluster
  • https://www.googleapis.com/auth/bigtable.admin.instance
  • https://www.googleapis.com/auth/cloud-bigtable.admin
  • https://www.googleapis.com/auth/cloud-bigtable.admin.cluster
  • https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-03 UTC.