Stay organized with collections
Save and categorize content based on your preferences.
Creates a cluster within an instance.
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/*}/clusters
Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.
Authorization requires the following IAM permission on the specified resource parent:
bigtable.clusters.create
Query parameters
Parameters
clusterId
string
Required. The ID to be used when referring to the new cluster within its instance, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-08 UTC."],[[["\u003cp\u003eCreates a new cluster within a specified instance using a POST request to the provided URL.\u003c/p\u003e\n"],["\u003cp\u003eEither \u003ccode\u003eCluster.serve_nodes\u003c/code\u003e or \u003ccode\u003eCluster.cluster_config.cluster_autoscaling_config\u003c/code\u003e must be set, determining if the cluster is manually scaled or autoscaled.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003eparent\u003c/code\u003e parameter in the URL path, representing the instance name, and \u003ccode\u003eclusterId\u003c/code\u003e as a query parameter to identify the new cluster.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires specific IAM permissions on the parent resource, specifically \u003ccode\u003ebigtable.clusters.create\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe operation requires one of the many oauth scopes provided, such as \u003ccode\u003ehttps://www.googleapis.com/auth/bigtable.admin.instance\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.instances.clusters.create\n\nCreates a cluster within an instance.\n\nNote 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.\n\n### HTTP request\n\n`POST https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*}/clusters`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Cluster](/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters#Cluster).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Operation](/bigtable/docs/reference/admin/rest/v2/operations#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/bigtable.admin`\n- `https://www.googleapis.com/auth/bigtable.admin.cluster`\n- `https://www.googleapis.com/auth/bigtable.admin.instance`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin.cluster`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
