Resource: Instance
An isolated set of Cloud Spanner resources on which databases can be hosted.
JSON representation |
---|
{ "name": string, "config": string, "displayName": string, "nodeCount": integer, "processingUnits": integer, "state": enum ( |
Fields | |
---|---|
name |
Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form |
config |
Required. The name of the instance's configuration. Values are of the form |
displayName |
Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. |
nodeCount |
The number of nodes allocated to this instance. At most one of either nodeCount or processingUnits should be present in the message. This may be zero in API responses for instances that are not yet in state See the documentation for more information about nodes and processing units. |
processingUnits |
The number of processing units allocated to this instance. At most one of processingUnits or nodeCount should be present in the message. This may be zero in API responses for instances that are not yet in state See the documentation for more information about nodes and processing units. |
state |
Output only. The current instance state. For |
labels |
Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.).
See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. |
instanceType |
The |
endpointUris[] |
Deprecated. This field is not populated. |
createTime |
Output only. The time at which the instance was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The time at which the instance was most recently updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
freeInstanceMetadata |
Free instance metadata. Only populated for free instances. |
State
Indicates the current state of the instance.
Enums | |
---|---|
STATE_UNSPECIFIED |
Not specified. |
CREATING |
The instance is still being created. Resources may not be available yet, and operations such as database creation may not work. |
READY |
The instance is fully created and ready to do work such as creating databases. |
InstanceType
The type of this instance. The type can be used to distinguish product variants, that can affect aspects like: usage restrictions, quotas and billing. Currently this is used to distinguish FREE_INSTANCE vs PROVISIONED instances.
Enums | |
---|---|
INSTANCE_TYPE_UNSPECIFIED |
Not specified. |
PROVISIONED |
Provisioned instances have dedicated resources, standard usage limits and support. |
FREE_INSTANCE |
Free instances provide no guarantee for dedicated resources, [nodeCount, processingUnits] should be 0. They come with stricter usage limits and limited support. |
FreeInstanceMetadata
Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes.
JSON representation |
---|
{
"expireTime": string,
"upgradeTime": string,
"expireBehavior": enum ( |
Fields | |
---|---|
expireTime |
Output only. Timestamp after which the instance will either be upgraded or scheduled for deletion after a grace period. ExpireBehavior is used to choose between upgrading or scheduling the free instance for deletion. This timestamp is set during the creation of a free instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
upgradeTime |
Output only. If present, the timestamp at which the free instance was upgraded to a provisioned instance. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
expireBehavior |
Specifies the expiration behavior of a free instance. The default of ExpireBehavior is |
ExpireBehavior
Allows users to change behavior when a free instance expires.
Enums | |
---|---|
EXPIRE_BEHAVIOR_UNSPECIFIED |
Not specified. |
FREE_TO_PROVISIONED |
When the free instance expires, upgrade the instance to a provisioned instance. |
REMOVE_AFTER_GRACE_PERIOD |
When the free instance expires, disable the instance, and delete it after the grace period passes if it has not been upgraded. |
Methods |
|
---|---|
|
Creates an instance and begins preparing it to begin serving. |
|
Deletes an instance. |
|
Gets information about a particular instance. |
|
Gets the access control policy for an instance resource. |
|
Lists all instances in the given project. |
|
Updates an instance, and begins allocating or releasing resources as requested. |
|
Sets the access control policy on an instance resource. |
|
Returns permissions that the caller has on the specified instance resource. |