Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, instances.create
returns ALREADY_EXISTS
.
Immediately upon completion of this request:
- The instance is readable via the API, with all requested attributes but no allocated resources. Its state is
CREATING
.
Until completion of the returned operation:
- Cancelling the operation renders the instance immediately unreadable via the API.
- The instance can be deleted.
- All other attempts to modify the instance are rejected.
Upon completion of the returned operation:
- Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
- Databases can be created in the instance.
- The instance's allocated resource levels are readable via the API.
- The instance's state becomes
READY
.
The returned long-running operation will have a name of the format <instance_name>/operations/<operationId>
and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata
. The response field type is Instance
, if successful.
HTTP request
POST https://spanner.googleapis.com/v1/{parent=projects/*}/instances
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The name of the project in which to create the instance. Values are of the form Authorization requires the following IAM permission on the specified resource
|
Request body
The request body contains data with the following structure:
JSON representation |
---|
{
"instanceId": string,
"instance": {
object ( |
Fields | |
---|---|
instance |
Required. The ID of the instance to create. Valid identifiers are of the form |
instance |
Required. The instance to create. The name may be omitted, but if specified must be |
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/spanner.admin
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.