Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use instances.partialUpdateInstance.
HTTP request
PUT https://bigtableadmin.googleapis.com/v2/{name=projects/*/instances/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
name
|
The unique name of the instance. Values are of the form |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "displayName" : string , "state" : enum ( |
displayName
string
Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
state
enum (
State
)
Output only. The current state of the instance.
type
enum (
Type
)
The type of the instance. Defaults to PRODUCTION
.
labels
map (key: string, value: string)
Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.
- Label keys must be between 1 and 63 characters long and must conform to the regular expression:
[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}. - Label values must be between 0 and 63 characters long and must conform to the regular expression:
[\p{Ll}\p{Lo}\p{N}_-]{0,63}. - No more than 64 labels can be associated with a given resource.
- Keys and values must both be under 128 bytes.
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
createTime
string (
Timestamp
format)
Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is seconds: 0, nanos: 1
.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
or "2014-10-02T15:01:23+05:30"
.
satisfiesPzs
boolean
Output only. Reserved for future use.
satisfiesPzi
boolean
Output only. Reserved for future use.
Response body
If successful, the response body contains an instance of Instance
.
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 .
