Database Migration Service には、接続プロファイルと移行ジョブをプログラムで管理するための REST API が用意されています。REST API は、接続プロファイルと移行ジョブの作成と管理に関連するリソースによって定義されます。すべてのリソースとそのメソッドの詳細については、 Database Migration Service API リファレンスをご覧ください。
Database Migration Service REST API に直接リクエストを送信する場合、正しい形式のリクエストを作成して、認証済みユーザーとしてリクエストを承認し、返されたレスポンスを処理する必要があります。このドキュメントのタスクの多くでは、curl を使用した API の例が示されています。
API の使用例については、 Database Migration Service API リファレンスのリクエストのページをご覧ください。各ページには、複数のプログラミング言語で API を呼び出す例、正しい形式のリクエストの内容と、レスポンスで返されることが予想される内容を理解するのに役立つ、リクエスト固有の Explorer が含まれています。
次のいずれかの方法でインスタンスを管理する場合も、Database Migration Service API を間接的に使用します。
Google Cloud CLI: インスタンスの操作に使用できるコマンドライン インターフェース（CLI）。
Google Cloud コンソール: グラフィカルなウェブ インターフェース。
これらの方法（特にGoogle Cloud コンソール）を使用する利点は、接続プロファイルと移行ジョブの管理を大幅に簡素化できることです（ユースケースによって異なります）。Database Migration Service を初めて使用する場合は、REST API を直接操作する前に、まずこれらのツールのいずれかを使用することをおすすめします。
API を有効にする
Database Migration Service API を使用するには、API を有効にする必要があります。
コンソール
- Database Migration Service API を有効にします。
- プロジェクトを選択します。
- [続行] を選択します。
gcloud
- 次のコマンドを入力して、 Google Cloudプロジェクトのプロジェクト ID を表示します。
gcloud projects list
- デフォルト プロジェクトを設定します。
gcloud config set project YOUR_PROJECT_ID
- Cloud SQL Admin API を有効にする
gcloud services enable datamigration.googleapis.com
権限
Database Migration Service API を使用するには、必要な権限が必要です。これらの権限には、以下が含まれます。
- Database Migration 管理者: この権限を持つユーザーは、接続プロファイルと移行ジョブの管理に使用される Database Migration Service のすべてのリソースにアクセスできます。
- Database Migration 閲覧者: この権限を持つユーザーは、Database Migration Service の接続プロファイルと移行ジョブに対する読み取り専用アクセス権を持ちます。
- Cloud SQL 管理者: この権限を持つユーザーは、Database Migration Service で Cloud SQL の接続プロファイルと移行ジョブを作成して管理できます。