使用 Database Migration Service API

Database Migration Service 提供了一个 REST API,用于以编程方式管理连接配置文件和迁移作业。REST API 由与创建和管理连接配置文件和迁移作业相关的资源定义。如需详细了解所有资源 及其方法,请参阅 Database Migration Service API 参考文档。

当您直接向 Database Migration Service REST API 发送请求时,必须创建正确形式的请求,以经过身份验证的用户身份授权请求,并处理返回的所有响应。本文档中的许多任务都提供了 使用 curl 的 API 示例。

如需查看更多使用 API 的示例,请参阅 Database Migration Service API 参考文档中相应请求的页面。每个页面都有用几种编程语言调用 API 的示例以及特定于请求的浏览器,以帮助您了解格式良好的请求中包含哪些内容以及响应中应该包含哪些内容。

当您使用以下任何一种方式来管理实例时,您也在间接使用 Database Migration Service API:

使用这些方法(尤其是 Google Cloud 控制台)的优势在于,它们可以极大地简化 连接配置文件和迁移作业的管理(具体取决于您的使用场景)。如果您刚开始使用 Database Migration Service,建议您先使用其中一种工具,然后再直接使用 REST API。

启用 API

如需使用 Database Migration Service API,您需要启用它:

控制台

  1. 启用 Database Migration Service API。
  2. 选择您的项目。
  3. 选择继续。

gcloud

  1. 输入以下命令,以显示项目的项目 ID: Google Cloud 项目:
    gcloud projects list
  2. 设置默认项目:
    gcloud config set project YOUR_PROJECT_ID
  3. 启用 Cloud SQL Admin API:
    gcloud services enable datamigration.googleapis.com

权限

您必须拥有使用 Database Migration Service API 所需的权限。这些权限包括:

  • Database Migration Admin:拥有此权限后,用户可以访问用于管理连接配置文件和迁移作业的 Database Migration Service 的所有资源。
  • Database Migration Viewer:拥有此权限后,用户可以对 Database Migration Service 中的连接配置文件和迁移作业进行只读访问。
  • Cloud SQL Admin:拥有此权限后,用户可以在 Database Migration Service 中为 Cloud SQL 创建和管理连接配置文件和迁移作业。