Method: googleapis.spanner.v1.projects.instances.create

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, CreateInstance 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 /operations/ and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. The polling policy for the long-running operation can be configured. For example, if you set skip_polling to True, the connector invocation call is non-blocking if the initial request succeeds; otherwise, retries might occur.

For more information about connector-specific parameters (connector_params), see Invoke a connector call.

For more information about retries and long-running operations, see Understand connectors.

Arguments

Parameters
parent

string

Required. The name of the project in which to create the instance. Values are of the form projects/.
body

object (CreateInstanceRequest)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
OperationError If the long-running operation finished unsuccessfully.
ResponseTypeError If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of Operation.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- create:
    call: googleapis.spanner.v1.projects.instances.create
    args:
        parent: ...
        body:
            instance:
                autoscalingConfig:
                    asymmetricAutoscalingOptions: ...
                    autoscalingLimits:
                        maxNodes: ...
                        maxProcessingUnits: ...
                        minNodes: ...
                        minProcessingUnits: ...
                    autoscalingTargets:
                        highPriorityCpuUtilizationPercent: ...
                        storageUtilizationPercent: ...
                config: ...
                defaultBackupScheduleType: ...
                displayName: ...
                edition: ...
                endpointUris: ...
                freeInstanceMetadata:
                    expireBehavior: ...
                instanceType: ...
                labels: ...
                name: ...
                nodeCount: ...
                processingUnits: ...
            instanceId: ...
    result: createResult

JSON

[
  {
    "create": {
      "call": "googleapis.spanner.v1.projects.instances.create",
      "args": {
        "parent": "...",
        "body": {
          "instance": {
            "autoscalingConfig": {
              "asymmetricAutoscalingOptions": "...",
              "autoscalingLimits": {
                "maxNodes": "...",
                "maxProcessingUnits": "...",
                "minNodes": "...",
                "minProcessingUnits": "..."
              },
              "autoscalingTargets": {
                "highPriorityCpuUtilizationPercent": "...",
                "storageUtilizationPercent": "..."
              }
            },
            "config": "...",
            "defaultBackupScheduleType": "...",
            "displayName": "...",
            "edition": "...",
            "endpointUris": "...",
            "freeInstanceMetadata": {
              "expireBehavior": "..."
            },
            "instanceType": "...",
            "labels": "...",
            "name": "...",
            "nodeCount": "...",
            "processingUnits": "..."
          },
          "instanceId": "..."
        }
      },
      "result": "createResult"
    }
  }
]