Creates an instance config and begins preparing it to be used. The returned long-running operation
can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, instanceConfigs.create
returns ALREADY_EXISTS
.
Immediately after the request returns:
- The instance config is readable via the API, with all requested attributes. The instance config's
reconciling
field is set to true. Its state isCREATING
.
While the operation is pending:
- Cancelling the operation renders the instance config immediately unreadable via the API.
- Except for deleting the creating resource, all other attempts to modify the instance config are rejected.
Upon completion of the returned operation:
- Instances can be created using the instance configuration.
- The instance config's
reconciling
field becomes false. Its state becomesREADY
.
The returned long-running operation
will have a name of the format <instance_config_name>/operations/<operationId>
and can be used to track creation of the instance config. The metadata
field type is CreateInstanceConfigMetadata
. The response
field type is InstanceConfig
, if successful.
Authorization requires spanner.instanceConfigs.create
permission on the resource parent
.
HTTP request
POST https://spanner.googleapis.com/v1/{parent=projects/*}/instanceConfigs
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The name of the project in which to create the instance config. 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 |
---|
{
"instanceConfigId": string,
"instanceConfig": {
object ( |
Fields | |
---|---|
instanceConfigId |
Required. The ID of the instance config to create. Valid identifiers are of the form |
instanceConfig |
Required. The InstanceConfig proto of the configuration to create. instanceConfig.name must be |
validateOnly |
An option to validate, but not actually execute, a request, and provide the same response. |
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.