Method: projects.instances.create

Create an instance within a project.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The unique name of the project in which to create the new instance. Values are of the form projects/<project>.

Authorization requires the following Google 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

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)

The instance to create. Fields marked OutputOnly must be left blank.

clusters

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

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. Currently, at most two clusters can be specified.

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.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Bigtable Documentation