Method: projects.instances.create

Stay organized with collections Save and categorize content based on your preferences.

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 uses gRPC 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 form projects/{project}.

Authorization requires the following IAM permission on the specified resource parent:

  • bigtable.instances.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., just myinstance rather than projects/myproject/instances/myinstance.

instance

object (Instance)

Required. The instance to create. Fields marked OutputOnly 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., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly 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 of Operation.

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 the Authentication Overview.