此页面由 Cloud Translation API 翻译。

创建和管理实例

本页面介绍了如何创建、列出、修改和删除 Spanner instances。

创建实例

您可以使用 Google Cloud 控制台、Google Cloud CLI 或客户端库创建实例。您还可以创建一个具有自定义实例配置方法是添加可选的只读副本。

控制台

在 Google Cloud 控制台中，前往 Spanner 实例页面。
点击创建实例。

转到“创建实例”
在选择版本部分，选择 Spanner 版本。

如果您想比较不同版本之间的规范，请点击版本对比。如需了解详情，请参阅 Spanner 版本概览。
点击继续。
在为实例命名部分，输入要在 Google Cloud 控制台中显示的实例名称。实例名称必须是唯一的 Google Cloud 项目中的资源。
输入实例 ID 以永久标识您的实例。此实例 ID 在您的 Google Cloud 项目中也必须是唯一的。实例 ID 创建后便无法更改。
点击继续。
在配置实例部分中，点击选择配置下方的区域、双区域或多区域。

注意：双区域和多区域实例配置仅适用于企业 Plus 版。如果您想比较三种配置的规格，然后点击 比较区域配置。
从下拉列表中选择配置位置。
可选：如需向 Spanner 基本配置中添加只读副本，请先使用 Google Cloud CLI 创建自定义实例配置。企业版和企业 Plus 版支持向基本配置添加可选的只读副本。
点击继续。
在分配计算容量部分的选择单位下，点击下列选项之一：
- 处理单元，适用于小型实例。
- 节点（适用于大型实例）。一个节点等于 1,000 个处理单元。
如需了解详情，请参阅计算容量、节点和处理单元。
在选择扩缩模式下，点击以下任一选项：
- 手动分配（如果要手动设置计算容量）固定计算资源和费用
  - 数量表示处理单元或节点的数量将用于此实例
- 自动扩缩（预览版）、让 Spanner 能够自动添加和移除容量。Spanner 企业版和企业 Plus 版提供托管式自动扩缩器。如需详细了解代管式自动扩缩器，请参阅 Spanner 的代管式自动扩缩器。配置以下托管式自动扩缩程序选项：
  - Minimum 表示要缩减到的最小限制，具体取决于您为计算容量。如需了解详情，请参阅确定最低限额。
  - 最大值表示要扩容到的最大值，具体取决于您为计算容量。如需了解详情，请参阅确定上限。
  - 高优先级 CPU 利用率目标表示目标高优先级 CPU 的利用率。如需了解详情，请参阅确定 CPU 利用率目标。
  - 存储空间利用率目标表示目标百分比存储空间如需了解详情，请参阅确定存储空间利用率目标。
点击创建以创建实例。

gcloud

使用 gcloud spanner instances create 命令来创建实例。将计算容量指定为实例上所需的节点数或处理单元数。

gcloud spanner instances create INSTANCE_ID \
--edition=EDITION \
--config=INSTANCE_CONFIG \
--description=INSTANCE_DESCRIPTION \
--nodes=NODE_COUNT

或

gcloud spanner instances create INSTANCE_ID \
--edition=EDITION \
--config=INSTANCE_CONFIG \
--description=INSTANCE_DESCRIPTION \
--processing-units=PROCESSING_UNIT_COUNT

替换以下内容：

INSTANCE-ID：在 Google Cloud 项目。实例 ID 创建后便无法更改。
INSTANCE-CONFIG：实例的永久性标识符配置，该配置定义了实例的地理位置以及会影响数据的复制方式。对于自定义实例配置以 custom- 开头。如需了解详情，请参阅实例配置。
INSTANCE_DESCRIPTION：要显示的实例名称 Google Cloud 控制台此实例名称在您的 Google Cloud 项目中必须是唯一的。
NODE-COUNT：实例的计算容量，以节点数表示。每个节点等于 1000 个处理单元。
PROCESSING_UNIT_COUNT：实例的计算容量，以处理单元数表示。最多可输入 1,000 的数量 100 的倍数（100、200、300 等），然后输入大于是 1000 的倍数（1000、2000、3000 等）。注意：如果您要创建所需的实例，请勿使用此参数稍后通过代管式自动扩缩器启用

添加托管式自动扩缩（预览版）

您还可以创建企业版企业 Plus 版将托管式自动扩缩功能与 gcloud beta spanner instances create 命令。如需了解详情，请参阅 Spanner 的代管式自动扩缩器。

使用以下命令创建具有代管式自动扩缩器的实例。

  gcloud beta spanner instances create INSTANCE_ID \
    --edition=EDITION \
    --config=INSTANCE_CONFIG \
    --description=INSTANCE_DESCRIPTION \
    --autoscaling-min-processing-units=MINIMUM_PROCESSING_UNITS \
    --autoscaling-max-processing-units=MAXIMUM_PROCESSING_UNITS \
    --autoscaling-high-priority-cpu-target=CPU_PERCENTAGE \
    --autoscaling-storage-target=STORAGE_PERCENTAGE

或

  gcloud beta spanner instances create INSTANCE_ID \
    --edition=EDITION \
    --config=INSTANCE_CONFIG \
    --description=INSTANCE_DESCRIPTION \
    --autoscaling-min-nodes=MINIMUM_NODES \
    --autoscaling-max-nodes=MAXIMUM_NODES \
    --autoscaling-high-priority-cpu-target=CPU_PERCENTAGE \
    --autoscaling-storage-target=STORAGE_PERCENTAGE

替换以下内容：

INSTANCE-ID：在 Google Cloud 项目。实例 ID 创建后便无法更改。
INSTANCE-CONFIG：实例的永久性标识符配置，该配置定义了实例的地理位置以及会影响数据的复制方式。对于自定义实例配置以 custom- 开头。如需了解详情，请参阅实例配置。
INSTANCE-DESCRIPTION：要显示的实例名称 Google Cloud 控制台此实例名称在您的 Google Cloud 项目中必须是唯一的。
MINIMUM_PROCESSING_UNITS、MINIMUM_NODES：处理单元数或节点数下限。有关相关信息，请参阅确定最低限制。
MAXIMUM_PROCESSING_UNITS、MAXIMUM_NODES：最大处理单元数或节点数上限。如需了解详情，请参阅确定上限。
CPU_PERCENTAGE：要使用的高优先级 CPU 的目标百分比，介于 10 到 90% 之间。如果您要针对费用进行优化，请使用更高的百分比。如需了解详情，请参阅确定 CPU 利用率目标。
STORAGE_PERCENTAGE：要使用的存储空间的目标百分比。从 10%到 99%如需了解详情，请参阅确定存储空间利用率目标。

使用自定义配置的示例

在基础区域实例中创建实例“test-instance” 配置 us-central1，请运行以下命令：

gcloud spanner instances create test-instance --edition=STANDARD --config=regional-us-central1 \
  --description="Test Instance" --nodes=1

在自定义多区域位置 custom-eur6-instance 创建实例实例配置 custom-eur6，第一个创建自定义实例配置。

然后运行以下命令：

  gcloud spanner instances create custom-eur6-instance --edition=ENTERPRISE_PLUS --config=custom-eur6 \
      --description="Instance with custom read-only" --nodes=1

运行实验之后，您应该看到类似于以下示例的消息上述任一命令：

Creating instance...done.

C++

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。

void CreateInstance(google::cloud::spanner_admin::InstanceAdminClient client,
                    std::string const& project_id,
                    std::string const& instance_id,
                    std::string const& display_name,
                    std::string const& config_id) {
  namespace spanner = ::google::cloud::spanner;
  spanner::Instance in(project_id, instance_id);

  auto project = google::cloud::Project(project_id);
  std::string config_name =
      project.FullName() + "/instanceConfigs/" + config_id;
  auto instance =
      client
          .CreateInstance(spanner::CreateInstanceRequestBuilder(in, config_name)
                              .SetDisplayName(display_name)
                              .SetNodeCount(1)
                              .SetLabels({{"cloud_spanner_samples", "true"}})
                              .Build())
          .get();
  if (!instance) throw std::move(instance).status();
  std::cout << "Created instance [" << in << "]:\n" << instance->DebugString();
}

C#

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。


using Google.Api.Gax.ResourceNames;
using Google.Cloud.Spanner.Admin.Instance.V1;
using Google.Cloud.Spanner.Common.V1;
using Google.LongRunning;
using System;

public class CreateInstanceSample
{
    public Instance CreateInstance(string projectId, string instanceId)
    {
        // Create the InstanceAdminClient instance.
        InstanceAdminClient instanceAdminClient = InstanceAdminClient.Create();

        // Initialize request parameters.
        Instance instance = new Instance
        {
            InstanceName = InstanceName.FromProjectInstance(projectId, instanceId),
            ConfigAsInstanceConfigName = InstanceConfigName.FromProjectInstanceConfig(projectId, "regional-us-central1"),
            DisplayName = "This is a display name.",
            NodeCount = 1,
            Labels =
            {
                { "cloud_spanner_samples", "true" },
            }
        };
        ProjectName projectName = ProjectName.FromProject(projectId);

        // Make the CreateInstance request.
        Operation<Instance, CreateInstanceMetadata> response = instanceAdminClient.CreateInstance(projectName, instanceId, instance);

        Console.WriteLine("Waiting for the operation to finish.");

        // Poll until the returned long-running operation is complete.
        Operation<Instance, CreateInstanceMetadata> completedResponse = response.PollUntilCompleted();

        if (completedResponse.IsFaulted)
        {
            Console.WriteLine($"Error while creating instance: {completedResponse.Exception}");
            throw completedResponse.Exception;
        }

        Console.WriteLine($"Instance created successfully.");

        return completedResponse.Result;
    }
}

Go

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。

import (
	"context"
	"fmt"
	"io"

	instance "cloud.google.com/go/spanner/admin/instance/apiv1"
	"cloud.google.com/go/spanner/admin/instance/apiv1/instancepb"
)

func createInstance(w io.Writer, projectID, instanceID string) error {
	// projectID := "my-project-id"
	// instanceID := "my-instance"
	ctx := context.Background()
	instanceAdmin, err := instance.NewInstanceAdminClient(ctx)
	if err != nil {
		return err
	}
	defer instanceAdmin.Close()

	op, err := instanceAdmin.CreateInstance(ctx, &instancepb.CreateInstanceRequest{
		Parent:     fmt.Sprintf("projects/%s", projectID),
		InstanceId: instanceID,
		Instance: &instancepb.Instance{
			Config:      fmt.Sprintf("projects/%s/instanceConfigs/%s", projectID, "regional-us-central1"),
			DisplayName: instanceID,
			NodeCount:   1,
			Labels:      map[string]string{"cloud_spanner_samples": "true"},
			Edition:     instancepb.Instance_STANDARD,
		},
	})
	if err != nil {
		return fmt.Errorf("could not create instance %s: %w", fmt.Sprintf("projects/%s/instances/%s", projectID, instanceID), err)
	}
	// Wait for the instance creation to finish.
	i, err := op.Wait(ctx)
	if err != nil {
		return fmt.Errorf("waiting for instance creation to finish failed: %w", err)
	}
	// The instance may not be ready to serve yet.
	if i.State != instancepb.Instance_READY {
		fmt.Fprintf(w, "instance state is not READY yet. Got state %v\n", i.State)
	}
	fmt.Fprintf(w, "Created instance [%s]\n", instanceID)
	return nil
}

使用 Go（预览版）创建具有托管式自动扩缩功能的实例

import (
	"context"
	"fmt"
	"io"

	instance "cloud.google.com/go/spanner/admin/instance/apiv1"
	"cloud.google.com/go/spanner/admin/instance/apiv1/instancepb"
	"google.golang.org/genproto/protobuf/field_mask"
)

// Example of creating an autoscaling instance with Go.
// projectID is the ID of the project that the new instance will be in.
// instanceID is the ID of the new instance to be created.
func createInstanceWithAutoscalingConfig(w io.Writer, projectID, instanceID string) error {
	// projectID := "my-project-id"
	// instanceID := "my-instance"
	ctx := context.Background()
	instanceAdmin, err := instance.NewInstanceAdminClient(ctx)
	if err != nil {
		return fmt.Errorf("could not create instance admin client for project %s: %w", projectID, err)
	}
	defer instanceAdmin.Close()

	instanceName := fmt.Sprintf("projects/%s/instances/%s", projectID, instanceID)
	fmt.Fprintf(w, "Creating instance %s.", instanceName)

	op, err := instanceAdmin.CreateInstance(ctx, &instancepb.CreateInstanceRequest{
		Parent:     fmt.Sprintf("projects/%s", projectID),
		InstanceId: instanceID,
		Instance: &instancepb.Instance{
			Config:      fmt.Sprintf("projects/%s/instanceConfigs/%s", projectID, "regional-us-central1"),
			DisplayName: "Create instance example",
			AutoscalingConfig: &instancepb.AutoscalingConfig{
				AutoscalingLimits: &instancepb.AutoscalingConfig_AutoscalingLimits{
					MinLimit: &instancepb.AutoscalingConfig_AutoscalingLimits_MinNodes{
						MinNodes: 1,
					},
					MaxLimit: &instancepb.AutoscalingConfig_AutoscalingLimits_MaxNodes{
						MaxNodes: 2,
					},
				},
				AutoscalingTargets: &instancepb.AutoscalingConfig_AutoscalingTargets{
					HighPriorityCpuUtilizationPercent: 65,
					StorageUtilizationPercent:         95,
				},
			},
			Labels: map[string]string{"cloud_spanner_samples": "true"},
		},
	})
	if err != nil {
		return fmt.Errorf("could not create instance %s: %w", instanceName, err)
	}
	fmt.Fprintf(w, "Waiting for operation on %s to complete...", instanceID)
	// Wait for the instance creation to finish.
	i, err := op.Wait(ctx)
	if err != nil {
		return fmt.Errorf("waiting for instance creation to finish failed: %w", err)
	}
	// The instance may not be ready to serve yet.
	if i.State != instancepb.Instance_READY {
		fmt.Fprintf(w, "instance state is not READY yet. Got state %v\n", i.State)
	}
	fmt.Fprintf(w, "Created instance [%s].\n", instanceID)

	instance, err := instanceAdmin.GetInstance(ctx, &instancepb.GetInstanceRequest{
		Name: instanceName,
		// Get the autoscaling_config field from the newly created instance.
		FieldMask: &field_mask.FieldMask{Paths: []string{"autoscaling_config"}},
	})
	if err != nil {
		return fmt.Errorf("failed to get instance [%s]: %w", instanceName, err)
	}
	fmt.Fprintf(w, "Instance %s has autoscaling_config: %s.", instanceID, instance.AutoscalingConfig)
	return nil
}

Java

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。


import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
import com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient;
import com.google.spanner.admin.instance.v1.CreateInstanceRequest;
import com.google.spanner.admin.instance.v1.Instance;
import com.google.spanner.admin.instance.v1.InstanceConfigName;
import com.google.spanner.admin.instance.v1.ProjectName;
import java.util.concurrent.ExecutionException;

class CreateInstanceExample {

  static void createInstance() {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project";
    String instanceId = "my-instance";
    createInstance(projectId, instanceId);
  }

  static void createInstance(String projectId, String instanceId) {
    // Set Instance configuration.
    int nodeCount = 2;
    String displayName = "Descriptive name";

    // Create an Instance object that will be used to create the instance.
    Instance instance =
        Instance.newBuilder()
            .setDisplayName(displayName)
            .setEdition(Instance.Edition.STANDARD)
            .setNodeCount(nodeCount)
            .setConfig(InstanceConfigName.of(projectId, "regional-us-east4").toString())
            .build();

    try (Spanner spanner =
            SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
        InstanceAdminClient instanceAdminClient = spanner.createInstanceAdminClient()) {

      // Wait for the createInstance operation to finish.
      Instance createdInstance =
          instanceAdminClient
              .createInstanceAsync(
                  CreateInstanceRequest.newBuilder()
                      .setParent(ProjectName.of(projectId).toString())
                      .setInstanceId(instanceId)
                      .setInstance(instance)
                      .build())
              .get();
      System.out.printf("Instance %s was successfully created%n", createdInstance.getName());
    } catch (ExecutionException e) {
      System.out.printf(
          "Error: Creating instance %s failed with error message %s%n",
          instance.getName(), e.getMessage());
    } catch (InterruptedException e) {
      System.out.println("Error: Waiting for createInstance operation to finish was interrupted");
    }
  }
}

使用 Java 创建具有托管式自动扩缩的实例（预览版）


import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
import com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient;
import com.google.spanner.admin.instance.v1.AutoscalingConfig;
import com.google.spanner.admin.instance.v1.CreateInstanceRequest;
import com.google.spanner.admin.instance.v1.Instance;
import com.google.spanner.admin.instance.v1.InstanceConfigName;
import com.google.spanner.admin.instance.v1.ProjectName;
import java.util.concurrent.ExecutionException;

class CreateInstanceWithAutoscalingConfigExample {

  static void createInstance() {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project";
    String instanceId = "my-instance";
    createInstance(projectId, instanceId);
  }

  static void createInstance(String projectId, String instanceId) {
    try (Spanner spanner =
        SpannerOptions.newBuilder()
            .setProjectId(projectId)
            .build()
            .getService();
        InstanceAdminClient instanceAdminClient = spanner.createInstanceAdminClient()) {
      // Set Instance configuration.
      String configId = "regional-us-east4";
      String displayName = "Descriptive name";

      // Create an autoscaling config.
      // When autoscaling_config is enabled, node_count and processing_units fields
      // need not be specified.
      AutoscalingConfig autoscalingConfig =
          AutoscalingConfig.newBuilder()
              .setAutoscalingLimits(
                  AutoscalingConfig.AutoscalingLimits.newBuilder().setMinNodes(1).setMaxNodes(2))
              .setAutoscalingTargets(
                  AutoscalingConfig.AutoscalingTargets.newBuilder()
                      .setHighPriorityCpuUtilizationPercent(65)
                      .setStorageUtilizationPercent(95))
              .build();
      Instance instance =
          Instance.newBuilder()
              .setAutoscalingConfig(autoscalingConfig)
              .setDisplayName(displayName)
              .setConfig(
                  InstanceConfigName.of(projectId, configId).toString())
              .build();

      // Creates a new instance
      System.out.printf("Creating instance %s.%n", instanceId);
      try {
        // Wait for the createInstance operation to finish.
        Instance instanceResult = instanceAdminClient.createInstanceAsync(
            CreateInstanceRequest.newBuilder()
                .setParent(ProjectName.of(projectId).toString())
                .setInstanceId(instanceId)
                .setInstance(instance)
                .build()).get();
        System.out.printf("Autoscaler instance %s was successfully created%n",
            instanceResult.getName());
      } catch (ExecutionException e) {
        System.out.printf(
            "Error: Creating instance %s failed with error message %s%n",
            instance.getName(), e.getMessage());
      } catch (InterruptedException e) {
        System.out.println("Error: Waiting for createInstance operation to finish was interrupted");
      }
    }
  }
}

Node.js

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。


// Imports the Google Cloud client library
const {Spanner, protos} = require('@google-cloud/spanner');

// Creates a client
const spanner = new Spanner({
  projectId: projectId,
});

const instanceAdminClient = await spanner.getInstanceAdminClient();
/**
 * TODO(developer): Uncomment the following lines before running the sample.
 **/
// const projectId = 'my-project-id';
// const instanceId = 'my-instance';

// Creates a new instance
try {
  console.log(
    `Creating instance ${instanceAdminClient.instancePath(
      projectId,
      instanceId
    )}.`
  );
  const [operation] = await instanceAdminClient.createInstance({
    instanceId: instanceId,
    parent: instanceAdminClient.projectPath(projectId),
    instance: {
      config: instanceAdminClient.instanceConfigPath(
        projectId,
        'regional-us-central1'
      ),
      nodeCount: 1,
      displayName: 'Display name for the instance.',
      labels: {
        cloud_spanner_samples: 'true',
        created: Math.round(Date.now() / 1000).toString(), // current time
      },
      edition:
        protos.google.spanner.admin.instance.v1.Instance.Edition.STANDARD, //optional
    },
  });

  console.log(`Waiting for operation on ${instanceId} to complete...`);
  await operation.promise();

  console.log(`Created instance ${instanceId}.`);
} catch (err) {
  console.error('ERROR:', err);
}

PHP

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。

use Google\Cloud\Spanner\Admin\Instance\V1\Client\InstanceAdminClient;
use Google\Cloud\Spanner\Admin\Instance\V1\CreateInstanceRequest;
use Google\Cloud\Spanner\Admin\Instance\V1\Instance;

/**
 * Creates an instance.
 * Example:
 * ```
 * create_instance($projectId, $instanceId);
 * ```
 *
 * @param string $projectId  The Spanner project ID.
 * @param string $instanceId The Spanner instance ID.
 */
function create_instance(string $projectId, string $instanceId): void
{
    $instanceAdminClient = new InstanceAdminClient();
    $parent = InstanceAdminClient::projectName($projectId);
    $instanceName = InstanceAdminClient::instanceName($projectId, $instanceId);
    $configName = $instanceAdminClient->instanceConfigName($projectId, 'regional-us-central1');
    $instance = (new Instance())
        ->setName($instanceName)
        ->setConfig($configName)
        ->setDisplayName('dispName')
        ->setNodeCount(1);

    $operation = $instanceAdminClient->createInstance(
        (new CreateInstanceRequest())
        ->setParent($parent)
        ->setInstanceId($instanceId)
        ->setInstance($instance)
    );

    print('Waiting for operation to complete...' . PHP_EOL);
    $operation->pollUntilComplete();

    printf('Created instance %s' . PHP_EOL, $instanceId);
}

Python

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。

def create_instance(instance_id):
    """Creates an instance."""
    from google.cloud.spanner_admin_instance_v1.types import \
        spanner_instance_admin

    spanner_client = spanner.Client()

    config_name = "{}/instanceConfigs/regional-us-central1".format(
        spanner_client.project_name
    )

    operation = spanner_client.instance_admin_api.create_instance(
        parent=spanner_client.project_name,
        instance_id=instance_id,
        instance=spanner_instance_admin.Instance(
            config=config_name,
            display_name="This is a display name.",
            node_count=1,
            labels={
                "cloud_spanner_samples": "true",
                "sample_name": "snippets-create_instance-explicit",
                "created": str(int(time.time())),
            },
            edition=spanner_instance_admin.Instance.Edition.STANDARD,  # Optional
        ),
    )

    print("Waiting for operation to complete...")
    operation.result(OPERATION_TIMEOUT_SECONDS)

    print("Created instance {}".format(instance_id))

Ruby

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。

# project_id  = "Your Google Cloud project ID"
# instance_id = "Your Spanner instance ID"

require "google/cloud/spanner"
require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.instance_admin

project_path = instance_admin_client.project_path project: project_id
instance_path = instance_admin_client.instance_path project: project_id, instance: instance_id
instance_config_path = instance_admin_client.instance_config_path project: project_id, instance_config: "regional-us-central1"

job = instance_admin_client.create_instance parent: project_path,
                                            instance_id: instance_id,
                                            instance: { name: instance_path,
                                                        config: instance_config_path,
                                                        display_name: instance_id,
                                                        node_count: 2,
                                                        labels: { cloud_spanner_samples: "true" } }

puts "Waiting for create instance operation to complete"

job.wait_until_done!

if job.error?
  puts job.error
else
  puts "Created instance #{instance_id}"
end

列出实例

您可以显示 Spanner 实例的列表。

控制台

前往 Google Cloud 控制台中的 Spanner 实例页面。

转到“实例”页面

Google Cloud 控制台会显示 Spanner 列表以及每个实例的 ID、显示名称、配置和计算容量，同时以处理单元和节点为单位。

gcloud

使用 gcloud spanner instances list 命令：

gcloud spanner instances list

gcloud CLI 会输出 Spanner 实例的列表，以及每个实例的 ID、显示名称、配置和计算容量。

修改实例

以下部分介绍了如何升级实例的版本，以及更改实例的显示名称和计算容量。您无法更改实例 ID 或实例配置（不过，您可以移动实例）。

升级版本

您可以将标准版实例升级到更高层级版本。标准版实例可以升级到企业版或企业 Plus 版。企业版实例可以升级到企业 Plus 版。

不支持自助降级。如需降级实例的版本，请提交支持服务工单。如需了解详情，请参阅 Spanner 版本常见问题解答。

控制台

前往 Google Cloud 控制台中的 Spanner 实例页面。

转到“实例”页面
点击要升级的实例的名称。
点击版本类型旁边的升级。
在实例版本页面中，在更新版本下，为您的实例选择新的更高层级版本。
点击保存。

gcloud

使用 gcloud spanner instances update 命令升级实例的版本：

gcloud spanner instances update INSTANCE_ID --edition=EDITION \
[--async]

替换以下内容：

INSTANCE_ID：实例的永久性标识符。
EDITION：为您的实例指定新的更高层级版本。如需了解详情，请参阅 Spanner 版本概览。

可选标志：

--async：如果您希望请求立即返回，而不等待正在进行的操作完成，请使用此标志。您可以查看通过运行 gcloud spanner operations describe。

Go

import (
	"context"
	"fmt"
	"io"

	instance "cloud.google.com/go/spanner/admin/instance/apiv1"
	"cloud.google.com/go/spanner/admin/instance/apiv1/instancepb"
	"google.golang.org/genproto/protobuf/field_mask"
)

func updateInstance(w io.Writer, projectID, instanceID string) error {
	// projectID := "my-project-id"
	// instanceID := "my-instance"
	ctx := context.Background()
	instanceAdmin, err := instance.NewInstanceAdminClient(ctx)
	if err != nil {
		return err
	}
	defer instanceAdmin.Close()

	req := &instancepb.UpdateInstanceRequest{
		Instance: &instancepb.Instance{
			Name: fmt.Sprintf("projects/%s/instances/%s", projectID, instanceID),
			// The edition selected for this instance.
			// Different editions provide different capabilities at different price points.
			// For more information, see https://cloud.google.com/spanner/docs/editions-overview.
			Edition: instancepb.Instance_ENTERPRISE,
		},
		FieldMask: &field_mask.FieldMask{
			Paths: []string{"edition"},
		},
	}
	op, err := instanceAdmin.UpdateInstance(ctx, req)
	if err != nil {
		return fmt.Errorf("could not update instance %s: %w", fmt.Sprintf("projects/%s/instances/%s", projectID, instanceID), err)
	}
	// Wait for the instance update to finish.
	_, err = op.Wait(ctx)
	if err != nil {
		return fmt.Errorf("waiting for instance update to finish failed: %w", err)
	}

	fmt.Fprintf(w, "Updated instance [%s]\n", instanceID)
	return nil
}

Java


import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerOptions;
import com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient;
import com.google.common.collect.Lists;
import com.google.protobuf.FieldMask;
import com.google.spanner.admin.instance.v1.Instance;
import com.google.spanner.admin.instance.v1.InstanceConfigName;
import com.google.spanner.admin.instance.v1.InstanceName;
import com.google.spanner.admin.instance.v1.UpdateInstanceRequest;
import java.util.concurrent.ExecutionException;

public class UpdateInstanceExample {

  static void updateInstance() {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project";
    String instanceId = "my-instance";
    updateInstance(projectId, instanceId);
  }

  static void updateInstance(String projectId, String instanceId) {
    // Set Instance configuration.
    int nodeCount = 2;
    String displayName = "Updated name";

    // Update an Instance object that will be used to update the instance.
    Instance instance =
        Instance.newBuilder()
            .setName(InstanceName.of(projectId, instanceId).toString())
            .setDisplayName(displayName)
            .setNodeCount(nodeCount)
            .setEdition(Instance.Edition.ENTERPRISE)
            .setConfig(InstanceConfigName.of(projectId, "regional-us-east4").toString())
            .build();

    try (Spanner spanner =
            SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
        InstanceAdminClient instanceAdminClient = spanner.createInstanceAdminClient()) {

      // Wait for the updatedInstance operation to finish.
      Instance updatedInstance =
          instanceAdminClient
              .updateInstanceAsync(
                  UpdateInstanceRequest.newBuilder()
                      .setFieldMask(
                          FieldMask.newBuilder().addAllPaths(Lists.newArrayList("edition")))
                      .setInstance(instance)
                      .build())
              .get();
      System.out.printf("Instance %s was successfully updated%n", updatedInstance.getName());
    } catch (ExecutionException e) {
      System.out.printf(
          "Error: Updating instance %s failed with error message %s%n",
          instance.getName(), e.getMessage());
    } catch (InterruptedException e) {
      System.out.println("Error: Waiting for updateInstance operation to finish was interrupted");
    }
  }
}

Node.js

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。


// Imports the Google Cloud client library
const {Spanner, protos} = require('@google-cloud/spanner');

/**
 * TODO(developer): Uncomment the following lines before running the sample.
 */
// const projectId = 'my-project-id';
// const instanceId = 'my-instance';

// Creates a client
const spanner = new Spanner({
  projectId: projectId,
});

const instanceAdminClient = spanner.getInstanceAdminClient();

// Updates an instance
try {
  console.log(
    `Updating instance ${instanceAdminClient.instancePath(
      projectId,
      instanceId
    )}.`
  );
  const [operation] = await instanceAdminClient.updateInstance({
    instance: {
      name: instanceAdminClient.instancePath(projectId, instanceId),
      labels: {
        updated: 'true',
        created: Math.round(Date.now() / 1000).toString(), // current time
      },
      edition:
        protos.google.spanner.admin.instance.v1.Instance.Edition.ENTERPRISE, //optional
    },
    // Field mask specifying fields that should get updated in an Instance
    fieldMask: (protos.google.protobuf.FieldMask = {
      paths: ['labels', 'edition'],
    }),
  });

  console.log(`Waiting for operation on ${instanceId} to complete...`);
  await operation.promise();
  console.log(`Updated instance ${instanceId}.`);
  const [metadata] = await instanceAdminClient.getInstance({
    name: instanceAdminClient.instancePath(projectId, instanceId),
  });
  console.log(
    `Instance ${instanceId} has been updated with the ${metadata.edition} ` +
      'edition.'
  );
} catch (err) {
  console.error('ERROR:', err);
}

Python

如需了解如何安装和使用 Spanner 客户端库，请参阅 Spanner 客户端库。

如需向 Spanner 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。

def update_instance(instance_id):
    """Updates an instance."""
    from google.cloud.spanner_admin_instance_v1.types import \
        spanner_instance_admin

    spanner_client = spanner.Client()

    name = "{}/instances/{}".format(spanner_client.project_name, instance_id)

    operation = spanner_client.instance_admin_api.update_instance(
        instance=spanner_instance_admin.Instance(
            name=name,
            labels={
                "sample_name": "snippets-update_instance-explicit",
            },
            edition=spanner_instance_admin.Instance.Edition.ENTERPRISE,  # Optional
        ),
        field_mask=field_mask_pb2.FieldMask(paths=["labels", "edition"]),
    )

    print("Waiting for operation to complete...")
    operation.result(OPERATION_TIMEOUT_SECONDS)

    print("Updated instance {}".format(instance_id))

更改显示名称

控制台

前往 Google Cloud 控制台中的 Spanner 实例页面。

转到“实例”页面
点击您要重命名的实例的名称。
点击修改实例。
输入新的实例名称。此名称在 Google Cloud 项目中必须是唯一的。
点击保存。

gcloud

使用 gcloud spanner instances update 命令：

gcloud spanner instances update INSTANCE_ID --description=INSTANCE_NAME

替换以下内容：

INSTANCE_ID：实例的永久性标识符。
INSTANCE_NAME：要在 Google Cloud 控制台中显示的实例名称。此实例名称在您的 Google Cloud 项目中必须是唯一的。

更改计算容量

您必须预配足够的计算容量，以将 CPU 利用率和存储空间利用率保持在建议的最大值以下。如需了解详情，请参阅 Spanner 的配额和限制。

在少数情况下，您无法减少应用的计算容量现有实例：

移除计算容量需要您的实例的每个节点（1,000 个处理单元）存储超过 4 TB 的数据。
根据您的历史使用模式，Spanner 为您的实例数据创建了大量分块，并且在某些罕见情况下，在移除计算容量后，Spanner 将无法管理分块。

在后一种情况下，您可以尝试逐步减少计算容量直到找到 Spanner 支持的最小容量，需要管理实例的所有分块如果实例不再需要由于使用模式变化导致的分片过多，Spanner 可能最终将一些分块合并在一起在一两周后进一步增加实例的计算容量。

移除计算容量时，请监控 CPU 利用率和请求 Cloud Monitoring 中的延迟时间，以确保 CPU 区域级的利用率保持在 65% 以下每个区域各占 45% 多区域实例移除计算容量时，您可能会遇到请求延迟暂时增加的情况。

如果想要增加实例的计算容量，您的 Google Cloud 项目必须具有足够的配额才能添加计算容量。增加请求的处理时间取决于请求的大小。在大多数情况下，请求会在几分钟内完成。已开启在极少数情况下，纵向扩容最多可能需要一个小时才能完成。

控制台

前往 Google Cloud 控制台中的 Spanner 实例页面。

转到“实例”页面
点击要更改的实例名称。
点击修改实例。
通过选择测量单位来更改计算容量（处理单元或节点），然后输入数量。使用处理单元时，以 100 的倍数（100、200、300 等）输入最多 1000 的数量，并以 1000 的倍数（1000、2000、3000 等）输入更大的数量。每个节点等于 1000 个处理单元。
点击保存。

如果系统对话框提示此位置没有足够的配额来添加计算容量，请按照说明请求更高配额。

gcloud

使用 gcloud spanner instances update 命令。使用此命令时，请以节点数或处理单元数的形式指定计算容量。

gcloud spanner instances update INSTANCE_ID --nodes=NODE_COUNT
[--async]

或

gcloud spanner instances update INSTANCE_ID
--processing-units=PROCESSING_UNIT_COUNT [--async]

替换以下内容：

INSTANCE_ID：实例的永久性标识符。
NODE_COUNT：实例的计算容量，以节点数表示。每个节点等于 1000 个处理单元。
PROCESSING_UNIT_COUNT：实例的计算容量。处理单元数以 100 的倍数（100、200、300 等）输入最多 1000 的数量，并以 1000 的倍数（1000、2000、3000 等）输入更大的数量。

可选标志：

--async：如果您希望请求立即返回，而不等待正在进行的操作完成，请使用此标志。您可以查看通过运行 gcloud spanner operations describe。

在实例上启用或停用代管式自动扩缩器

添加或更改代管式自动扩缩时，存在以下限制现有实例上的另一个功能：

托管式自动扩缩器仅适用于企业版或企业 Plus 版。
您无法在要迁移的实例上启用托管式自动扩缩器。
当托管式自动扩缩器处于下列状态时，您无法移动实例。

控制台

前往 Google Cloud 控制台中的 Spanner 实例页面。

转到“实例”页面
点击要启用代管式的实例的名称自动扩缩器。
点击修改实例。
在配置计算容量下，点击自动扩缩。
对于下限，请选择缩减时要使用的下限。如需了解详情，请参阅确定最低限制。
对于上限，选择纵向扩容时要使用的上限。对于如需了解详情，请参阅确定上限。
对于高优先级 CPU 利用率目标，请选择要使用的高优先级 CPU 百分比。如需了解详情，请参阅确定 CPU 利用率目标。
在存储空间利用率目标中，选择要使用的存储空间百分比。如需了解详情，请参阅确定存储空间利用率目标。
点击保存。

gcloud

使用 gcloud beta spanner instances update 命令将托管式自动扩缩器添加到实例。如需了解详情和限制，请参阅 Google Cloud CLI 标志和限制。

您可以使用以下命令添加托管式自动扩缩器：

  gcloud beta spanner instances update INSTANCE_ID \
    --autoscaling-min-processing-units=MINIMUM_PROCESSING_UNITS \
    --autoscaling-max-processing-units=MAXIMUM_PROCESSING_UNITS \
    --autoscaling-high-priority-cpu-target=CPU_PERCENTAGE \
    --autoscaling-storage-target=STORAGE_PERCENTAGE

或

  gcloud beta spanner instances update INSTANCE_ID \
    --autoscaling-min-processing-units=MINIMUM_NODES \
    --autoscaling-max-processing-units=MAXIMUM_NODES \
    --autoscaling-high-priority-cpu-target=CPU_PERCENTAGE \
    --autoscaling-storage-target=STORAGE_PERCENTAGE

替换以下内容：

INSTANCE_ID：实例的永久性标识符。
MINIMUM_PROCESSING_UNITS、MINIMUM_NODES：缩减时要使用的处理单元或节点的最小数量。如需了解详情，请参阅确定最低限制。
MAXIMUM_PROCESSING_UNITS、MAXIMUM_NODES：纵向扩容时要使用的处理单元或节点数量上限。对于请参阅确定上限。
CPU_PERCENTAGE：要使用的高优先级 CPU 的目标百分比，介于 10% 到 90% 之间。如果您要优化费用并且不要求较低的费用所有请求的延迟时间，然后使用更高的百分比。有关请参阅确定 CPU 利用率目标。
STORAGE_PERCENTAGE：要使用的存储空间的目标百分比。从 10% 到 99%如需了解详情，请参阅确定存储空间利用率目标。

将托管式自动扩缩器添加到实例后，您还可以修改托管式自动扩缩器设置。例如，如果您想提高增加到 10, 000 个处理单元，请运行以下命令：

gcloud beta spanner instances update test-instance \
     --autoscaling-max-processing-units=10000

将实例从使用代管式自动伸缩器更改为手动伸缩

控制台

前往 Google Cloud 控制台中的 Spanner 实例页面。

转到“实例”页面
点击要停用代管式实例的名称自动扩缩器。
在选择伸缩模式下，点击手动分配。
点击保存。

gcloud

使用 gcloud beta spanner instances update 命令更新实例。

使用以下命令将实例从使用代管式自动伸缩器更改为手动伸缩：

  gcloud beta spanner instances update INSTANCE_ID \
  --processing-units=PROCESSING_UNIT_COUNT

或

  gcloud beta spanner instances update INSTANCE_ID \
  --nodes=NODE_COUNT

替换以下内容：

INSTANCE_ID：实例的永久性标识符。
NODE_COUNT：实例的计算容量，以节点数表示。每个节点等于 1000 个处理单元。
PROCESSING_UNIT_COUNT：实例的计算容量。处理单元数以 100 的倍数（100、200、300 等）输入最多 1000 的数量，并以 1000 的倍数（1000、2000、3000 等）输入更大的数量。

为实例添加标签

标签可帮助您整理资源。

控制台

前往 Google Cloud 控制台中的 Spanner 实例页面。

转到“实例”页面
选中实例对应的复选框。页面右侧将显示信息面板。
点击信息面板中的标签标签页。然后，您可以添加、删除或更新 Spanner 实例的标签。

移动实例

如需了解如何将实例从任意实例配置任何其他实例配置，包括单区域级和多区域级之间的配置请参阅移动实例。

删除实例

您可以使用 Google Cloud 控制台或 Google Cloud CLI。

如果您要删除一个实例，而该实例中有一个或多个数据库启用了删除保护，则必须先为该实例中的所有数据库停用删除保护，然后才能删除该实例。

控制台

前往 Google Cloud 控制台中的 Spanner 实例页面。

转到“实例”页面
点击要删除的实例名称。
点击删除实例。
按照说明进行操作，确认您要删除实例。
点击删除。

gcloud

使用 gcloud spanner instances delete 命令，并将 INSTANCE_ID 替换为实例 ID：

gcloud spanner instances delete INSTANCE_ID

停止或重启实例

Spanner 是一项全代管式数据库服务，可监控自己的底层任务和资源，包括监控和重启必要时无需停机由于无需手动停止或重启给定实例，Spanner 不提供操作。

后续步骤

了解如何插入、更新和删除数据数据操纵语言 (DML) 或 gcloud CLI。
为实例及其数据库授予 Identity and Access Management 角色。
了解如何设计 Spanner 架构。